Access Using API Key

From DreamFactory
Jump to: navigation, search
DreamFactoryTutorialsAccess Using API Key

DreamFactory APIs can be consumed with just an API key. Each app has a unique API key that is sent with each request. When no session token is provided, the request is considered to be from an unauthenticated user and the system uses the API key to look up the default role for the app. The default role for the app specifies what resources unauthenticated users have access to.

Request:

GET https://foo.com/api/v2/db/_table?api_key=abc123efg

If passing multiple parameters, such as filter or limit:

GET https://foo.com/api/v2/db/_table?limit=1&api_key=abc123efg
  • HTTP method: GET
  • URL: https://foo.com/api/v2
  • Service: db
  • Resource: _table
  • Additional Parameter: limit
  • API key: abc123efg

Note: API key can also be supplied using the X-DreamFactory-Api-Key request header.