API Authentication

API access requires valid authentication credentials, and the associated admin user must have the API Access permission in their role group.
Generate API credentials in the Admin area.
Each request must include an API token, and the calling IP must be whitelisted in the API Access settings. 

  • Generate API Token
    Generate an API token by navigating to Configurations → Manage API Credentials in the Admin area (left menu). 

    In the API Credentials tab, click Generate New API Credential.


    Click at Generate New API Credential button.


    Select access permissions for new API token and click at Add API Credential button at right bottom of modal.

  • Manage API IP

    Add remote IP  by navigating to Configurations → Manage API Credentials in the Admin area (left menu).

    In the Manage API IP tab, click Add IP Addewss button.

    After clicking Add IP Address, a modal will appear where you can enter the IP address for remote API calls.


    Enter the IP address and click Save. You can now use the newly generated token in your API calls.


    For API code samples, go to Admin Area → Configuration → Manage API Credentials, then open the API Documentation tab.
    Each API endpoint includes detailed information, an auto-generated execution form, and sample code in multiple languages: PHP cURL, PHP PECL, Go, C#, C# Rest, Kotlin, Node.js, Ruby, Python, and Dart.