Authentication
Send your API key in the x-api-key header of every request under /v1:
curl https://api.sandbox.gave.sh/v1/users/alice/balance \
-H "x-api-key: $GAVE_API_KEY"Every request is scoped to the key's integrator: you only ever see your own users, rewards and vault.
Refusals
| Status | Error | Meaning | What to do |
|---|---|---|---|
401 | Unauthorized | The key is missing or unknown | Check the header and the key |
403 | IntegratorSuspended | Your integrator is suspended | Contact Gave |
403 | IntegratorMismatch | A spend event's integratorId isn't the key's | Send your own integrator ID |
429 | RateLimited | Too many requests | Retry after retryAfterSeconds |
503 | Unavailable | The key couldn't be checked right now | Retry: it's not a bad key |
The response body is described in Errors.