Prerequisites for using the Public API

Prerequisites for using the Public API

Before proceeding with the authorisation process for the ApprovalMax Public API feature, there are certain prerequisites that need to be met. These include:

1. Granting access to the Developer Portal: in order to access the Developer Portal and utilise the ApprovalMax Public API feature, please,
request access to the Developer Portal. 

2. Creating an application on the Developer Portal: it is mandatory to create an application on the Developer Portal to access the ApprovalMax Public API feature. When creating an application, you generate credentials that will be used for authentication purposes. These credentials are essential for establishing a secure connection between your application and the API. Without creating an application and obtaining the necessary credentials, access to the API feature will not be possible.

3. User roles: to grant access on the consent page, the user must have the role of either Account Owner, 
Account Manager or Administrator. This role requirement is in place to control access to sensitive data. It ensures that only users with the appropriate roles can authorise access to the API feature. If a user does not hold the required role, the system will not allow access to the API.

    • Related Articles

    • Public API Guide

      Our Public API Guide is available on our website, please follow this link to find it: ApprovalMax – Public API Guide
    • What does the ApprovalMax Public API do?

      The ApprovalMax API enables other systems to retrieve data from ApprovalMax and display it in their own systems without any manual action by a person. This seamless integration facilitates the automation of data transfers by pulling the relevant ...
    • How to call the API

      Please refer to the Swagger page or the list of available endpoints to find endpoints and their data models. To successfully make API calls, include the following headers in your requests to authenticate and communicate with the API correctly: ...
    • A list of endpoints available in the Public API

      To make calls against the APIs, please refer to the endpoints below or to the swagger : Endpoints Description GET /ping This endpoint is used for checking the overall availability and responsiveness of the ApprovalMax Public API. When a GET request ...
    • How to grant access to an Organisation via the ApprovalMax Public API

      This is how you grant access to an Organisation via the ApprovalMax API: 1. Initiate a user authorisation: generate an URL with the necessary parameters to direct the Account Owner / Account Manager / Organisation Administrator to the ApprovalMax ...