Cyclr API Home
Cyclr provides Swagger documentation for the API. You can use the interactive API documentation to view available parameters, as well as to help you test endpoints as you work with the Cyclr API.
API domain and reference documentation
Your API domain depends on the Cyclr instance your Partner Console is hosted on:
Cyclr Console Location | API Domain | Interactive API Reference |
|---|---|---|
Private Instance | https://{your-api-instance} | https://{your-api-instance}/docs/index |
API Reference Authorization
You can use your Cyclr account details to authenticate and work with all API endpoints directly within the API reference documentation.
Expand the endpoint and select the OFF slider.
In the new window, select either Basic auth or Request body from the dropdown.
Enter the ClientID and Secret that you want to use to authenticate.
Select Authorize.
Cyclr supports OAuth authentication. For more information, see the API authentication documentation.
Note: 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 account ID header is included with the request.