Getting started
1. Obtain credentials
Contact Loady Support or your Customer Success Manager. Loady provides an OAuth client ID and secret, a subscription key, the customer company ID, and the APIs enabled for your integration.
Store credentials in a secret manager. Do not place them in source control, browser code, URLs, logs, or support tickets.
2. Obtain an access token
Use the OAuth 2.0 client credentials flow described in Authentication. Cache the token until shortly before expiry instead of requesting a new token for every API call.
3. Call a versioned API
- Environment
- PG
- API base URL
https://api-playground.loady.com/public
API URLs append the case-sensitive public API path and version to the base URL shown above. The exact server URL for every API is shown in its generated reference. Don't guess the path from an API's display name or title.
Send the bearer token, subscription key, and the headers required by the selected operation. Start with a read operation where available, then implement writes idempotently.
4. Correlate and monitor
Log the response's x-correlation-id header alongside any failures. Respect 429 Too Many Requests and Retry-After; retry transient failures with bounded exponential backoff and jitter.