Developer

Setting Up the API

To begin using the Kinabase API, follow these steps:

  1. In the bottom-right corner of the screen, select Settings.
  2. From the list, select the API tab (note: you must be an administrator to access this, and on the Enterprise plans).
  3. Click + Add in the top-right corner to create a new App Registration, which is required to use the Kinabase API.
  4. Enter a Name (required) and an Description (optional) for the app.
  5. The app’s credentials will be generated. These credentials are needed to obtain an authentication token and make API requests, and consist of an App ID and an App Secret.

Authentication

Before making any requests to the Kinabase API, you need to authenticate by generating a token. The steps to obtain a token are as follows:

  1. Copy the App ID and App Secret from the API settings after registering your app.
  2. Send a POST request to https://app.kinabase.com/api/v1/api/v1/token with the following JSON body:
{  
    "appId": "{your-app-id}",  
    "appSecret": "{your-app-secret}"  
}
  1. If successful, you’ll receive a return status 200 along with an authentication token. Cache this token, as you will need it for subsequent requests. The token is valid for 1 hour.
  2. If your token is invalidated or expires, simply generate a new one by repeating this process.