Guides

Client Api

Suggest Edits

Overview

The Client API feature in AppNavi allows tenant owners to securely create and manage API clients to integrate AppNavi data into external systems. This guide outlines the steps to enable, configure, and manage API clients.

Enabling Client API

To enable API access:

  1. Navigate to the Manage Tenant section in the portal.
  2. In the Settings tab, locate the Client API toggle.
  3. Enable the toggle and save the changes.
  4. A new tab titled Client API will appear.

Accessing the Client API Section

  1. Go to the Client API tab.
  2. Click the three-dots menu (⋮) in the top-right corner.
  3. Two options will be displayed:
  • Add
  • Refresh

Adding a New API Client

  1. Clicking on Add will open a dialog where a new API client can be configured.
  2. Fields in Add API Client Dialog:

  • Title: Provide a meaningful name for the client.

  • Description: Add a description for reference.

  • Permissions:

    • Select one or both modules: Insights and Discovery.
    • The selected modules determine where this client ID can be used.
    • If only "Insights" or "Discovery "is selected, the credentials will only be valid for the Insights or the Discovery module.
    • If both are selected, the credentials work for both modules.
  • Upon creating:
    • A Client ID and Client Secret will be generated.
    • The Client Secret is displayed only once. It is recommended to copy and securely store this secret (e.g., in a secure note or password manager).

Managing API Clients

  • A tenant can create up to 5 API Clients.
  • Each API client contains:
    • Title
    • Description
    • Client ID (always visible)
    • Client Secret (only shown once)
    • Authorized Modules and Actions

Permissions and Actions

Each API client can be assigned one or more modules and actions:

Available Modules:

  • Discovery
  • Insights

Available Actions:

  • discoveryApps (related to Discovery)
  • executeReport (related to Insights)

These actions are presented in a user-friendly format with translated titles and descriptions, based on the user's language.

Editing an API Client

Existing API clients can be edited to:

  • Update the Title and Description.
  • Modify the Authorized Modules and their respective Actions.

Note: The Client Secret will not be re-displayed. If the secret is lost, a new API client must be created.

Updated 22 days ago