Getting access#
OAuth#
AirHub uses client credentials to authenticate and authorize requests. Successful authentication will return an Oauth2 accessToken. AirHub expects the accessToken to be included in all subsequent API requests using the Authorization header.Client Credentials#
AirHub uses client credentials and an API key to authenticate and authorize requests. Successful authentication will return an Oauth2 accessToken. AirHub expects the accessToken and x-api-key to be included in all subsequent API requests.HTTP Request#
POST https://airhub-api-sandbox.airspacelink.com/v1/oauth/token| Parameter | Description |
|---|
Content-Type | application/x-www-form-urlencoded |
x-api-key | <your-api-key> |
| Parameter | Description |
|---|
grant_type | client_credentials |
client_id | Client id supplied to you by Airspace Link |
client_secret | Client secret supplied to you by Airspace Link |
scope | See available Oauth Scopes |
Scopes#
In addition to the Client ID and Secret, you must also supply one or many oauth scopes. If you're unfamiliar with scopes, you can think of them as bundles of related API endpoints that are authorized for access by your client application. Multiple scopes may be requested by separating each scope by a space.Available Scopes#
| Scope | Description |
|---|
advisory:read | Grants read access to our available advisories. This includes local and federal flight advisories. |
aviation:read | Grants read access to aviation facility map data. |
briefing:area:read | Grants read access to briefings by area. |
briefing:location:read | Grants read access to briefings by location. |
hazar:read | hazar is short for "Hazards and Risks". Grants read access to our hazar data. |
operation:create | Used for linking applications. Allows the creation of a UAS operation that can be linked into LAANC authorization app. |
route:create | Allows the creation of UAS waypoints that navigate around ground based hazards and risks. |
surface:create | Allows the creation of hex surfaces based on specified data sources |
Examples#
Below are some examples using our sandbox environment, https://airhub-api-sandbox.airspacelink.com/.Make sure to replace <your-xxx> with your applicable values.
{
"status": 200,
"message": "success",
"data": {
"accessToken": "xyz123",
"expires": "2021-03-16T21:57:33.332Z",
"scope": "advisory:read"
}
}
