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 or
Account Manager. 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

    • What does the ApprovalMax Public API do?

      The ApprovalMax API provides for other systems the capability to retrieve data from ApprovalMax and display it in their own systems without requiring manual actions from individuals. This allows for a seamless integration and enables the automation ...
    • How to grant access to an Organisation in the ApprovalMax Public API

      The process of granting access to an Organisation consists of the following steps: 1. Initiate user authorisation: generate an URL with the necessary parameters. This URL will direct account owners/ account managers to the ApprovalMax Public API ...
    • 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, ensure that you include the following headers in your requests: Authorisation header: this is crucial for ...
    • The list of endpoints available in Public API

      To make calls against the APIs, please refer to the endpoints below or to the swagger: Endpoints Description GET /ping In the ApprovalMax Public API, the GET /ping endpoint is a simple endpoint used for checks the overall availability and ...
    • How to initiate an authorisation process

      To initiate the authorisation process, you need to create a URL with the necessary parameters that will redirect the user to the ApprovalMax system for authorisation. When incorporating values that should be added as parameters into the URL, the ...