Appearance
Authentication
To access our API and generate your key, you have to be subscribed to our API plan.
Subscribe to our API plan here.
Obtaining your API key
When you have a subscription plan to our API, you can generate your API key by following these steps:
- Go to the 'My API Keys' page.
- Click on the
Create new API key
button. - Name your API key and click on the
Create key
button.
Note: Keep your API key secure and do not share it with anyone.
- Do not expose your API key in public repositories or client-side code.
- Treat it as you would your password.
- If you suspect that your API key has been compromised, regenerate it immediately.
Making a test API request
You can test your API key directly from the OpenApi documentation page.
- Add your API key in the
Authorization
field - Select the endpoint you want to test
- click on the
Test Request
button and fill in the required parameters to perform the test.