uslimato
|

API Authentication

Overview

The Uslimato public API uses API key authentication. Every request must include a valid API key in the Authorization header.

Authentication Header

Authorization: Bearer usl_live_<your-api-key>

Example:

curl https://api.uslimato.com/v1/assets \
  -H "Authorization: Bearer usl_live_abc123..."

Getting an API Key

API keys are created in the Developer Portal at app.uslimato.com/developer. You need the Admin role to create keys.

Security Guidelines

  • Never expose API keys in client-side code (browsers, mobile apps)
  • Store keys in environment variables or a secrets manager
  • Use the most restrictive set of scopes necessary
  • Set an expiry date for keys used in one-off scripts
  • Rotate keys regularly for long-lived integrations
  • Revoke unused or compromised keys immediately

Error Responses

All API errors return JSON with an error field:

{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}
HTTP StatusCodeMeaning
401UNAUTHORIZEDMissing or invalid API key
403FORBIDDENKey does not have required scope
404NOT_FOUNDResource not found
429RATE_LIMITEDRate limit exceeded
500INTERNAL_ERRORServer error — contact support

Rate Limiting Headers

Every response includes rate limit information:

HeaderDescription
X-RateLimit-LimitMaximum requests per hour
X-RateLimit-RemainingRequests remaining in current window
X-RateLimit-ResetUnix timestamp when the window resets

Tenant Isolation

API keys are scoped to a single tenant. You cannot use a key from one organization to access another organization's data.