Access Using API Key
From DreamFactory
Tracyosborn (Talk | contribs) m (Updated the example / details order to show the example first) |
Toddappleton (Talk | contribs) |
||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
DreamFactory 2.0 APIs can be consumed with just an API Key. The access is limited by the default role assigned to the | DreamFactory 2.0 APIs can be consumed with just an API Key. The access is limited by the default role assigned to the | ||
application of the API key that is being used. | application of the API key that is being used. | ||
Revision as of 20:08, 22 June 2016
DreamFactory 2.0 APIs can be consumed with just an API Key. The access is limited by the default role assigned to the application of the API key that is being used.
API Endpoints
{Method} https://{url}/api/v2/{service}/{resource}?api_key={api-key}
-- OR --
{Method} https://{url}/api/v2/{service}/{resource}
Request header
...
X-DreamFactory-Api-Key: {api_key}
...
Example - Using URL parameter
GET https://foo.com/api/v2/system/user?api_key=abc123efg
- Service: system
- Resource: user
- API Key: abc123efg
- Method: GET
- Request URL:
Example - Using request header
... X-DreamFactory-Api-Key: abc123efg ...
Request URL:
GET https://foo.com/api/v2/system/user
- Service: system
- Resource: user
- API Key: abc123efg
- Method: GET
- Request Header:
