Public API Access
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 ...
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 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 ...
How to verify authorised Organisations with access permissions
To determine which Organisations the Account Owner has authorised, you can make a call to the /companies endpoint using the received token. In response, you will receive a list of Organisations UUIDs to which access has been granted. To retrieve ...
Receiving tokens
When you send the POST request to the token endpoint, the endpoint validates the request parameters to ensure the authenticity and validity of the code. It checks factors such as the expiration of the code and whether it matches the client ID. If the ...
How to exchange an authorisation code for an access token
Once you have obtained the authorisation code from the user, you can proceed to exchange it for an access token. When making this exchange, it is recommended to request the "offline_access" scope, which allows you to receive a refresh token in ...
Redirecting users back to your application with an authorisation code
When users authorise your app and interact with the ApprovalMax Public API, the API will redirect them back to the redirect_uri that you have specified. During this redirection process, certain parameters will be included in the URL: code: represents ...
How to grant access to an Organisation via the Consent page
During the authorisation flow, having initiated the process, the Account Owner or Account Manager is redirected to a Consent page. Here, they can manually select the Organisation(s) they wish to grant access to. The Consent page displays a list of ...
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 ...
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 ...
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 ...