API Tab

Owned by kapil.katewa (Unlicensed)
Last updated: May 06, 2024
2 min read

API Tab

The API tab in Settings is the place where we manage Applications. These Applications refer to 3rd party systems requiring API access for reading or managing resources within Yunibas.

Applications specifically denote third-party applications that will be authorized to access a tenant’s data via the API.

API tab overview

  • The “Tenant ID” and “API Key” values can be copied by click on the copy icon in front of them. These values will be needed to make API calls into Yunibas.

  • The “API Key” has an optional expiration. If expired, it will no longer be valid.

  • A new “API Key” can be generated at any time. The expiration will be based on the Application settings.

Add Application

Follow below steps to add application

  1. Click on the "Add Application" button located on the API tab.

  2. Add application form will be shown.

  3. You are prompt to fill below details

    1. Name: Typically the name of the system making the API calls

    2. Description: Typically a reminder to admin the purpose of allowing these API calls

    3. Expiration: How long the API key will be good for each time it is generated

      • 7 Days

      • 30 Days

      • 90 Days

      • Custom

      • No expiration

    4. Permissions: Defines the permissions available to this API key

    5. Save

      • On add, an API key will be generated

  4. Click the "Save" button or icon to generate the API card.

  5. Application card will be generate and confirmation message will be shown.

     

  6. On created application card expiration days will be shown to indication in how many days this application will be expired.

Configure Application

Follow below steps to configure application created on API tab

  1. Click anywhere on the application card on the API tab to configure

  2. Application modification/setting form will be shown.

  3. You can configure the application below field -

    1. Name

    2. Description

    3. Permission

    4. Note - On update, the existing API key will be unchanged. So expiration field will not be configured.

  4. Click Save button or Icon to save the changes.

  5. Application card will be saved and confirmation message will be shown.

 

Regenerate API Key

Click on the "Regenerate Key" button located on the application card to generate the new API key. On new API key generation confirmation message will be shown.

Delete Application

  1. On clicking “Delete“ button located on the application card a confirmation message will be shown.

  2. Click on the confirm button on the confirmation pop up.

  3. Application card will be deleted and confirmation message will be shown.

Module Video Guide -