Skip to main content

​
Authentication Methods

The API authenticates requests with the X-Aegister-Token. Send it in either of two ways.

​
1. Header-Based Authentication

Include the X-Aegister-Token in the request headers. Prefer this method: it keeps the token out of the URL and out of server logs. Example Request: 
GET /api/v1/resource HTTP/1.1
Host: app.aegister.com
X-Aegister-Token: your_token_here
Curl Example: 
curl -H "X-Aegister-Token: your_token_here" https://app.aegister.com/api/v1/resource

​
2. Query Parameter Authentication

Pass the X-Aegister-Token as a query parameter in the URL. Use this method when you cannot set request headers. Example Request: 
GET /api/v1/resource?X-Aegister-Token=your_token_here HTTP/1.1
Host: app.aegister.com
Curl Example: 
curl https://app.aegister.com/api/v1/resource?X-Aegister-Token=your_token_here