Access Using JWT and API Key

From DreamFactory
Jump to: navigation, search
DreamFactoryTutorialsAccess Using JWT and API Key
      1. Tutorial

You can consume DreamFactory 2.0 APIs by providing the combination of JWT and API Key. This is more appropriate in case of a non-admin user. When consuming APIs using JWT and application API Key, access is limited by the role assigned to the user for the application of the API Key being used. Admin users always have access to all APIs using just the JWT.

      1. API Endpoints
{Method} https://{url}/api/v2/{service}/{resource}?session_token={JWT}&api_key={api-key}

-- OR -- 

{Method} https://{url}/api/v2/{service}/{resource}

Request header 

...
X-DreamFactory-Session-Token: {JWT}
X-DreamFactory-Api-Key: {api_key}
...
      1. Example - Using URL parameter
  • Service: system
  • Resource: user
  • Session Token: abc.123.efg
  • API Key: abc123efg
  • Method: GET
  • Request URL:
GET https://foo.com/api/v2/system/user?session_token=abc.123.efg&api_key=abc123efg
      1. Example - Using request header
  • Service: system
  • Resource: user
  • Session Token: abc.123.efg
  • API Key: abc123efg
  • Method: GET
  • Request Header:
...
X-DreamFactory-Session-Token: abc.123.efg
X-DreamFactory-Api-Key: abc123efg
...
  • Request URL:
GET https://foo.com/api/v2/system/user
Retrieved from "https://wiki.dreamfactory.com/index.php?title=DreamFactory/Tutorials/Access_Using_JWT_and_API_Key&oldid=30621"