Keys and environments
Every call carries an API key in the Authorization header:
GET /v1/shipments HTTP/1.1Host: api.ga-oms.comAuthorization: Bearer ga_live_YOUR_KEYGetting a key
Section titled “Getting a key”Your Golden Arcus contact creates a key for your account and gives it to you once. We keep only a fingerprint of it, so nobody at Golden Arcus can read it back to you later. If you lose it, ask for a new one and we revoke the old one.
You can hold more than one key, for example one per system. Each can be revoked on its own.
What a key can do
Section titled “What a key can do”- A key belongs to one account. It sees that account’s shipments and nothing else.
- A key has scopes.
shipments:readcovers everything on this site today. - A key works over https only. A call over plain http is refused with
https_required.
Environments
Section titled “Environments”| Key starts with | Works at |
|---|---|
ga_live_ |
https://api.ga-oms.com, your real shipments |
ga_test_ |
our test server, with made-up shipments. Ask us if you want to practise there first |
A key used in the wrong place is refused with wrong_environment, and the answer says where it works.
Keeping a key safe
Section titled “Keeping a key safe”- Store it as a secret on your server. Never put it in a web page, a mobile app or a repository.
- If a key may have leaked, tell us. We revoke it at once and issue another.
- A key is not a password: it does not sign anyone in to the customer dashboard.