Cyclr’s interactive API references can be used to try things out, and to help you while testing and creating your own native deployment or working with data on demand.
API Location/Instance
Depending on where your Cyclr Console is hosted, you’ll need to use the appropriate API Domain when making Requests:
| Cyclr Console Location | API Domain | Interactive API Reference |
|---|---|---|
| my.cyclr.com | https://api.cyclr.com | US API Reference |
| my.cyclr.uk | https://api.cyclr.uk | UK API Reference |
| eu.cyclr.com | https://api.eu.cyclr.com | EU API Reference |
API Reference Authorization
Use your Cyclr account details to authenticate and work with all API endpoints directly within the API reference documentation.
To authenticate, expand any endpoint and click the “OFF” slider, then enter your details:
Cyclr supports 2 of the OAuth 2.0 authentication flows:
- Client Credentials
- Password flow [support ends May 2021]
The Cyclr API is divided into two parts, the Partner Level and the Account Level, you can use the same OAuth token for both but account level methods require that the X-Cyclr-Account header is included with the request.
Edit me