API Wizard

Welcome to DreamFactory!

Thank you for signing up to DreamFactory. To help get you started, we have provided you with a dedicated MySQL Database containing several million records spread across six tables. You can use this database to generate an API, or use your own.

Please note that the Api Wizard is currently in beta. At present it supports the ability to instantly generate an API for MySQL and MS SQL Server. If you would like to create an API for another service, please go to the Services tab and generate your API from there.

Which service would you like to create your API for?

Generating API for: {{wizardData.type}}

DreamFactory will instantly generate an API from your {{wizardData.type}} database.
Just follow the steps to get started.

Lets start off by assigning a namespace (the URI endpoint), and a label so we can find it later.

Please provide the following credentials to hook up to your {{wizardData.type}} database. (If you require more advanced options, please create your connector from the Services tab)

Alternatively, in the email we sent you, you will find credentials to hook up to a MySQL database we have provided for you. Feel free to play around!

The namespace to be used for the API’s URI structure, such as 'db' in /api/v2/db. It should be lowercase and alphanumeric.

Assign a display name or label for the service.

Write a brief description of the API (optional).

🎉 Your {{wizardData.type}} API has been generated!

Would you like to generate a set of read-only-permissions (RBAC) so you can test it out?

🎉 We have generated a read only set of permissions.
ó € ó € ó €  Your API Key is {{apiKey}}

Copy the following curl command and execute it in your terminal to see the list of tables in your database

curl -X GET "{{baseUrl}}{{wizardData.namespace}}/_table/" -H "accept: application/json" -H "X-DreamFactory-Api-Key: {{apiKey}}"

Or copy the following curl command, amending the {tableName} and execute it in your terminal to see the first two results of that table:

curl -X GET "{{baseUrl}}{{wizardData.namespace}}/_table/{tableName}?limit=2" -H "accept: application/json" -H "X-DreamFactory-Api-Key: {{apiKey}}"

That's it! From here you can go to:

  • The Services tab to manage current APIs or create new ones.
  • The Roles tab to manage / create Role Based Access Controls.
  • The Apps tab to manage / create API Keys.
  • The API Docs tab to view documentation on created APIs.

No thanks, take me back to the homepage