API Overview

Our APIs offer comprehensive solutions for:

Generating an API Key

Step-by-Step Guide to Generating an API Key -

1

Log In to Your Account

  • Visit our website and log in with your credentials.
  • If you don’t have an account, sign up for one to get started.

2

Navigate to the Developer Setting Section

  • Once logged in, go to your user dashboard.
  • Find and click on the “Developer Settings” tab or section in the dashboard menu.

3

Request a New API Key

  • In the “Developer” section, click on the “Generate API Key” button.

  • You may be asked to provide select details for which you want to generate the API key.

4

Generate and Save Your API Key

  • Click the “Generate” button to create your API key.
  • Once generated, your API key will be displayed on the screen.

5

Start Using Your API Key

  • Your API key is now ready to use. Include it in your API requests as specified in the authentication section of our documentation.

Keep your API key secure and do not share it publicly.
If you suspect that your API key has been compromised, regenerate a new one immediately

API Key Management

  • Regenerate Key : If you need to regenerate your key, follow the same steps as above. The old key will be deactivate.

Authenticated requests

Enable user authentication via environment variable, each front-end API request includes an API key and OAuth2 token. These authenticate the request. Without proper permissions, the backend responds with a 4XX error.

API Errors

If a page loads with no visible data, it could indicate either a lack of data or insufficient user permissions.

If no error message appears on the page, check the browser’s network tab and inspect the API request response for full error details.

Learn how to view the network requests in Chrome by following these instructions
Error CodeDescription
401Expired / Invalid OAuth token
402Record is Invalid
403Invalid API Key
403Unauthorized access
404Record not found
500 API resource error