Skip to main content

Managing Applications and API Credentials

1. Managing Applications​

1.1 Creating Applications​

  1. Click Apps in the sidebar navigation.

Apps

  1. Click New App.

Create-app

  1. Enter required information into the fields.

Apps

  1. Click Next.

  2. Select the API endpoints.

Apps

  1. Click Connect and Generate Keys.
  2. When generation completes, you will see Successfully Generated your API Keys! with your Shared Key and Secret Key.
Important

Immediately copy and securely store your keys.

store-key

  1. The new key pair appears in the Access Keys tab.

store-key

1.2 Viewing Applications​

  1. Click Apps in the sidebar navigation.
  2. A grid view of all your applications is displayed.
  3. Each app card displays:
    • Title: Application name.
    • Description: Brief description of the application.

1.3 Application Details​

Click on any application card to view detailed information:

  • App Information: Title, description, and unique App ID.
  • API Credentials: Complete list of all API keys for this application.
  • Connected APIs: Complete list of API endpoints selected for this application.

2. Managing API Credentials​

Follow the steps to manage, generate, and revoke your API keys.

2.1 Understanding API Credentials​

Each application can have multiple API credential pairs. Each credential pair consists of:

  • Shared Key: Public key used for API authentication.
  • Secret Key: Private key used for API authentication (keep secure). This is only visible when a new key is generated.
Important

Immediately copy and securely store your keys.

  • Status: Active or Revoked status.
  • Creation Date: When the key was generated.

2.2 Generating New API Keys​

When to Generate:​

  • Setting up a new application.
  • Creating keys for different environments (development, staging, production).
  • Rotating keys for security compliance.
  • Replacing compromised keys.

How to Generate:​

  1. Click Apps in the sidebar navigation.

Apps

  1. Navigate to the Apps screen.

Apps-details

  1. In the Access Keys tab, click Generate Key.

generate-key

  1. Wait for the generation to complete.
  2. The new key pair appears in the Access Keys tab.
Important

Immediately copy and securely store your keys.

store-key

How to Revoke the Key:​

  1. Click Apps in the sidebar navigation.

  2. Navigate to the Apps screen.

  3. In the API Credentials section, toggle the icon to revoke the API key.

revoke keys

  1. The Revoking the Key dialog is displayed, select the desired action.

revoking the key dialog

Important

Once a key is revoked, it cannot be retrieved.

Security Warning
  • Secret keys are displayed only once when generated.
  • Store keys securely using a password manager or secure vault.
  • Never commit keys to version control or share them publicly.
  • Use different keys for different environments.
  • Rotate keys regularly for enhanced security.

2.3 Viewing Credentials​

The credentials table displays the following information:

  • Status: Active (green) or Inactive (gray) badge.
  • Shared Key: Full key value.
  • Secret Key: Full key value.
  • Creation Date: When the key was created.
  • Credential ID: Unique identifier for the key.

2.4 Best Practices for API Keys​

  • Environment Separation: Use different keys for development, staging, and production.
  • Documentation: Keep track of which keys are used in which applications.
  • Regular Rotation: Rotate keys periodically (recommended every 90 days).
  • Secure Storage: Store keys in environment variables or secure configuration files.
  • Access Control: Limit who has access to production keys.

Next Steps​

Continue to User Management and Organization Information for more information.