FastTrack

From DreamFactory
Jump to: navigation, search
DFEConsoleFastTrack
(Created page with "The FastTrack system is intended to provide a one-click entry into a DreamFactory%trade; instance. Calling this endpoint performs the following operations: # Validates the r...")
 
m
Line 14: Line 14:
  
 
=== The Endpoint ===
 
=== The Endpoint ===
The FastTrack endpoint depends on the domain name of the installation. We'll use `dfe.example.com` as our example installation.
+
The FastTrack endpoint depends on the domain name of the installation. We'll use <code>dfe.example.com<f/code> as our example installation.
  
The endpoint to call for this installation is `http://console.dfe.example.com/fast-trak`.
+
The endpoint to call for this installation is <code>http://console.dfe.example.com/fast-trak</code>.
  
 
=== The Payload ===
 
=== The Payload ===
Line 23: Line 23:
 
<syntaxhighlighter lang="json">
 
<syntaxhighlighter lang="json">
 
{
 
{
 +
  "redirect":  true|false,
 
   "email":      "[email protected]",
 
   "email":      "[email protected]",
 
   "first-name": "Joe",
 
   "first-name": "Joe",
Line 33: Line 34:
 
</syntaxhighlighter>
 
</syntaxhighlighter>
  
All fields are required except `company`, `nickname` and `phone`.
+
All fields are required except <code>redirect</code>, <code>company</code>, <code>nickname</code> and <code>phone</code>.
 +
 
 +
If the process is successful and <code>redirect</code> is '''true''', the response will be a 302 HTTP redirect directly to the newly launched instance. Otherwise, a standard DFE Console API response will be returned. The response details are as follows:
 +
 
 +
<syntaxhighlighter lang="json">
 +
{
 +
  "user": false|{
 +
    "id": 123,
 +
    ...
 +
  },
 +
  "instance-id": "[email protected]",
 +
  "instance":    false|{
 +
    "id": 123
 +
    ...
 +
  },
 +
  "instance-initialized": true|false,
 +
  "instance-admin":      true|false,
 +
  "redirect":            false|{
 +
    "location":          "redirect-uri",
 +
    "status-code":        302,
 +
    "payload": {
 +
      "fastTrackGuid":    "new user's registration request GUID"
 +
    }
 +
}
 +
</syntaxhighlighter>

Revision as of 20:07, 24 February 2016

The FastTrack system is intended to provide a one-click entry into a DreamFactory%trade; instance.

Calling this endpoint performs the following operations:

  1. Validates the request
  2. A DFE Dashboard user is created with the provided information
  3. An instance is created named using a portion of the email address
  4. The instance is initialized and the database is created
  5. An instance admin is created on the new instance
  6. The instance admin is logged in and the browser is redirected to the new instance

How to use FastTrack

You must call FastTrack with an HTTP POST with a JSON payload.

The Endpoint

The FastTrack endpoint depends on the domain name of the installation. We'll use dfe.example.com<f/code> as our example installation.

The endpoint to call for this installation is <code>http://console.dfe.example.com/fast-trak.

The Payload

The payload may contain the following properties:

<syntaxhighlighter lang="json"> {

 "redirect":   true|false,
 "email":      "[email protected]",
 "first-name": "Joe",
 "last-name":  "Blow",
 "password":   "gratePassW0rd!",
 "nickname":   "Joe",
 "company":    "",
 "phone":      ""

} </syntaxhighlighter>

All fields are required except redirect, company, nickname and phone.

If the process is successful and redirect is true, the response will be a 302 HTTP redirect directly to the newly launched instance. Otherwise, a standard DFE Console API response will be returned. The response details are as follows:

<syntaxhighlighter lang="json"> {

 "user": false|{
   "id": 123,
   ...
 },
 "instance-id": "[email protected]",
 "instance":    false|{
   "id": 123
   ...
 },
 "instance-initialized": true|false,
 "instance-admin":       true|false,
 "redirect":             false|{
   "location":           "redirect-uri",
   "status-code":        302,
   "payload": {
     "fastTrackGuid":    "new user's registration request GUID"
   }

} </syntaxhighlighter>