Access Using API Key
From DreamFactory
| Line 1: | Line 1: | ||
| − | + | === Tutorial === | |
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. | ||
| − | + | === API Endpoints === | |
<pre>{Method} https://{url}/api/v2/{service}/{resource}?api_key={api-key}</pre> | <pre>{Method} https://{url}/api/v2/{service}/{resource}?api_key={api-key}</pre> | ||
| Line 18: | Line 18: | ||
</pre> | </pre> | ||
| − | + | === Example - Using URL parameter === | |
* Service: system | * Service: system | ||
| Line 27: | Line 27: | ||
<pre>GET https://foo.com/api/v2/system/user?api_key=abc123efg</pre> | <pre>GET https://foo.com/api/v2/system/user?api_key=abc123efg</pre> | ||
| − | + | === Example - Using request header === | |
* Service: system | * Service: system | ||
Revision as of 17:18, 3 February 2016
Contents
Tutorial
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
- Service: system
- Resource: user
- API Key: abc123efg
- Method: GET
- Request URL:
GET https://foo.com/api/v2/system/user?api_key=abc123efg
Example - Using request header
- Service: system
- Resource: user
- API Key: abc123efg
- Method: GET
- Request Header:
... X-DreamFactory-Api-Key: abc123efg ...
- Request URL:
GET https://foo.com/api/v2/system/user
