Developer Portal: register a new application in the system and obtain both Client ID and Client Secret

Developer Portal: register a new application in the system and obtain both Client ID and Client Secret

The Developer Portal is a dedicated feature that ApprovalMax has introduced to simplify the registration and management of applications within our system. It's a web page specifically designed to handle the administration of applications and receive the necessary credentials for accessing our Public API.
The Developer Portal serves as a convenient tool for developers and other involved parties, enabling them to register their applications, manage their credentials, and ensure efficient control over access to the ApprovalMax Public API.
The Client ID and Client Secret are vital credentials necessary for an application to access the ApprovalMax Public API endpoints securely. They play crucial roles in the authentication and authorisation processes between the application and our API:
  1. The Client ID serves as a unique identifier assigned to each registered application. It helps identify and distinguish the specific application making requests to the API. This identification ensures that the API recognises and verifies the source of the incoming requests.
  2. The Client Secret, on the other hand, is a confidential and shared secret known only to the application and the ApprovalMax API. It acts as a secure key to authenticate the application and establish trust during the API communication. The Client Secret serves as a means of authenticating the application's identity and verifying its authorisation to access the ApprovalMax system.
By utilising the Client ID and Client Secret together, an application can authenticate and authorise access to the ApprovalMax Public API endpoints. This authentication process ensures that the API can verify the identity of the requesting application, granting the necessary permissions to access and manipulate data securely within the ApprovalMax system.

To register a new application in the system and obtain the necessary Client ID and Client Secret for authentication and authorisation processes, you can follow the steps below:
  1. Authorise and open the Developer Portal
    The ApprovalMax Developer Portal is specifically designed for individuals responsible for managing the application, whether they are developers or users. 
    To access the Developer Portal, it's crucial that you have a registered user account in the ApprovalMax system.

    To access the ApprovalMax Developer Portal, log into ApprovalMax, click on your Avatar first and then on Developer Portal(*):

    Please note: to access the Developer Portal, you must have beta access granted at user-level. This will enable you to create and manage your application, generate Client ID and Client Secrets that are used to authorise the Public API. Please request a beta via our support.

    Or, follow this link and sign in to the system using your login and password (these credentials are the same ones you use when logging into ApprovalMax), or via other services like Google, Xero, Intuit or Microsoft.

  2. Create a new application and save the generated Client ID and Client Secret

    1. On the opened web page, click on ADD NEW APPLICATION to open the registration form for new applications:

      If you are trying to create an application for the first time and no applications have been created previously, click on CREATE NEW APPLICATION:

    2. Fill in the fields Application Name and Application URL, then click on CREATE:

      A callback URL, also known as a redirect URL, is a web address that an authorisation server redirects the user to after it has granted access to your application. 
      When registering your application, you provide the callback URL to the authorisation server. This URL serves as a destination where the server redirects the user's browser to upon successful authorisation. The callback URL is designed to capture the authorisation code or access token, allowing your application to proceed with the authentication and authorisation process.

      By specifying the callback URL during the registration process, you inform the authorisation server about the appropriate endpoint to which the user is to be sent after granting access.

      Please note: i
      f you are using Postman, the redirect URL must be set to "". If you are using your own service, then provide its redirect URL.

    3. Upon creation of your application, the system will generate a unique Client ID and Client Secret for you. These credentials are essential for integrating your application with the relevant services.
      1. Click on the COPY buttons to copy the credentials to your clipboard. 
      2. Paste the copied credentials to a safe place, such as a password manager or a secure document. Avoid saving them in easily accessible or unencrypted locations to prevent unauthorised access.
      3. To close the form, click on the "X" button.

Important note: the Client Secret is a crucial piece of information; once you close the form, it will be hidden and cannot be regenerated or copied again. Therefore, ensure to copy the Client Secret before closing the form to prevent any loss of this sensitive information.

    • Related Articles

    • Developer Portal: how to delete an application

      To delete an application on the Developer Portal, follow the steps below: Open the Developer Portal, select the application you want to delete, click on the three-dot menu icon first and then on Delete: Confirm the deletion by clicking on DELETE, or ...
    • Developer Portal: how to edit an application

      To edit an application on the Developer Portal, follow the steps below: Open the Developer Portal, select the application you want to update data for, and click on it. Update the data in the fields you intend to modify, ensuring that all required ...
    • 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 ...
    • 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 ...
    • 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 ...