API Integration

Clevero has a fully dynamic RESTful API allows you to set up any desired integrations. Endpoints are completely user-configurable, allowing your team, Clevero or third-party consultants to create any custom integrations you need.

Create an API Key

Watch the guided demo below to create an API Key.

You can also follow the same steps using the written guide below.

  1. Go to "Settings" > "System Settings".
  2. Select the "API Endpoints" menu.
  3. Click the "Add" button to generate a new endpoint.
  4. Please provide the new endpoint name and select "record" as the scope to generate a new endpoint.
📘

Info:

You can select more than one scopes.

  1. Click on the "Create" button to proceed.
  2. The endpoint is successfully generated.
    1. Select the endpoint > copy the API key.
    2. Select the endpoint > click on the "View API Docs" to view the full endpoint reference.
👍

Note:

An API key is automatically generated upon the creation of an endpoint.

Error Handling

In this section, various errors related to API integration are discussed, along with troubleshooting steps for each error.

ErrorsTroubleshoot
Unable to render this definition
The provided definition does not specify a valid version field.
Please indicate a valid Swagger or OpenAPI version field. Supported version fields are swagger: "2.0" and those that match openapi: 3.0.n (for example, openapi: 3.0.0).
Authentication FailedReset your password or contact our support team for assistance.
Resource Not FoundThe resource might not be available, or there could be an issue with the server configuration. Contact our support team for assistance.
Internal Server ErrorYou can try again later. If you keep getting this error, please contact our support page below.

📌 Need Help?

If you require assistance or encounter any issues, please don't hesitate to contact us for further support.


Did this page help you?