How to authenticate and use HALOS APIs
To use the API, your organization will need API keys. These are provided by the HALOS engineering team to your engineers. If you'd like to request API keys, please make sure you are the billing contact or primary contact for the account and raise a ticket with HALOS support.
HALOS APIs are pretty easy to work with. You just need to POST/auth to get a token, then use any of the other APIs using that token.
The Basics
1. Your base URL is determined by which Vault you use:
| Vault | Login URL | API URL |
| UK Vault | https://app.halovault.cam | api.halovault.cam |
| US Vault | https://app.halovault.us | api.halovault.us |
2. Every API call must include the x-api-key in the header
3. Authenticate to get a bearer token before doing anything else
Example
You want to programmatically download the video file for a video uploaded by a camera
1. POST auth to get the token
POST https://api.halovault.cam/auth
Request Headers
x-api-key: "<x-api-key>"
Request Body
{
"key": "<key>",
"secret": "<secret>"
}
2. GET media to find all videos
GET https://api.halovault.cam/media
Request Headers
x-api-key: "<x-api-key>"
Authorization: "Bearer <vault-access-token>"
3. GET video URL for one of the videos from yesterday
GET https://api.halovault.cam/media/<media_id>/file
Request Headers
x-api-key: "<x-api-key>"
Authorization: "Bearer <vault-access-token>"
See our Swagger for the full set of APIs