An API (Application Programming Interface) lets two software apps communicate with each other. It lets you handle most admin tasks using your own code on your platform.
To access, navigate to Settings on the side menu, then select Manage API Keys from the Platform Settings:
IMPORTANT: Changes will not be updated until the SAVE button is clicked at the very bottom of the page.
API - Application Programming Interface
This page lets you manage your API keys and understand how the API works.
What is an API?
API stands for Application Programming Interface. It’s a tool that lets two applications communicate with each other. Using the API, you can perform most admin tasks through your own code and platform.
Authentication Methods:
You can authenticate with the API in two ways:
Using BasicAuth with an administrator’s username and password.
Use an API key that you generate on this page.
Additional resources:
Click the View Documentation button to access detailed API guides.
Download the API collection in JSON format or the OpenAPI definition in YAML format using the buttons provided.
API Keys
How to manage API keys:
Click Add API key to create a new key.
Each secret key is only shown once when you create it. Make sure to keep it safe!
If you lose the secret key, you’ll need to generate a new one and update your code.
API Keys Table:
This section lists all your API keys along with their titles, keys, secrets, and the last time they were used. Right now, no API keys have been created yet.
When you’ve updated both sections, click Save to apply your changes.