All /api/v1/* requests require a Bearer token in the Authorization header. GET /health is the only unauthenticated public endpoint.
Authorization: Bearer nx_live_YOUR_API_KEY
Key types
| Prefix | Environment | Notes |
|---|
nx_test_ | Sandbox | Same endpoints, test data only |
nx_live_ | Production | Full access, real data |
nx_test_ during development. Switch to nx_live_ in production.
Creating keys
- Sign in at platform.usenexio.com
- Open Settings → API Keys
- Click Create, give it a descriptive name, copy the value
Keys are shown only once. If you lose one, revoke it and create a new one.
Revoking keys
Go to Settings → API Keys, find the key, click Revoke. Revoked keys return 401 immediately.
Error response
{
"code": "unauthorized",
"message": "Missing or invalid API key"
}
503 with code: "auth_unavailable".
Never embed API keys in client-side code or public repositories. Use one key per integration point so revocation stays clean.
