Get the access token for the Reporting API and the other services on api.aerahost.com.
Master: api-docs.aerahost.comWe're moving our API docs to docs.aera.id. Until the move is done, 3. Access API on api-docs.aerahost.com is the master for this API. Use it to build your integration.
Access API gives you the access token for the Reporting API and the other services on api.aerahost.com. You log in with your client ID and client secret, and get an access token and a refresh token back. Send the access token as Authorization: Bearer <access token> in your requests.
What you can do
| Task | Endpoint | Details (master) |
|---|---|---|
| Get an access token | POST /access/oauth2/token | 3.2.3. Create an access token |
| Check whether a token is still active | POST /access/oauth2/introspect | 3.2.2. Introspect an access token |
| Check that the service is running | GET /access/health | 3.2.1. Get application status |
Fields and objects: 3.3. Definitions.
Hosts
| Environment | Host |
|---|---|
| Test | https://api-staging.aerahost.com |
| Production | https://api.aerahost.com |
Before you start
- Get your API key, client ID and client secret. See Get access.
- Read how tokens work and when they expire. See Authentication.