Authentication (API Keys)¶
DRAFT Specification / Work in Progress
This portion of the BTAA GIN site, our GeoBTAA API, and our Linked Data offerings are a WORK IN PROGRESS. Please reach out if you have questions or wish to participate in bringing these resources to public release.
The API uses simple apiKey authentication. Clients MUST supply a valid key via one of:
HTTPS header (preferred):
- X-API-Key: \<key>
- Query parameter (fallback):
?api_key=<key>
Keys are provisioned out‑of‑band by the service operator. A new key MUST be a 32‑character URL‑safe random string.
Key Status Endpoint¶
| Method | Path | Description |
|---|---|---|
| GET | /keys/self |
Returns metadata about the calling key (plan, quota, issued at, expires at). |
TODOs¶
- Add Authentication to API