Access Using API Key
From DreamFactory
Toddappleton (Talk | contribs) |
Toddappleton (Talk | contribs) |
||
| Line 1: | Line 1: | ||
| − | DreamFactory | + | DreamFactory APIs can be consumed with just an API key. Each app has a unique API key that is passed as part of each request. If no session token is provided, the access is limited by the default role assigned to the application with that API key. For this example assume your app's API key is abc123efg. |
| − | application | + | |
| − | + | Request: | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | Request | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
<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> | ||
| + | * HTTP Method: GET | ||
| + | * URL: https://foo.com/api/v2 | ||
* Service: system | * Service: system | ||
* Resource: user | * Resource: user | ||
* API Key: abc123efg | * API Key: abc123efg | ||
| − | |||
| − | |||
| − | + | Note: API key can also be supplied using the X-DreamFactory-Api-Key request header. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | X-DreamFactory-Api-Key | + | |
| − | . | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
Revision as of 19:10, 30 June 2016
DreamFactory APIs can be consumed with just an API key. Each app has a unique API key that is passed as part of each request. If no session token is provided, the access is limited by the default role assigned to the application with that API key. For this example assume your app's API key is abc123efg.
Request:
GET https://foo.com/api/v2/system/user?api_key=abc123efg
- HTTP Method: GET
- URL: https://foo.com/api/v2
- Service: system
- Resource: user
- API Key: abc123efg
Note: API key can also be supplied using the X-DreamFactory-Api-Key request header.
