Skip to main content
Sign in

Search

Flight Control Help Center

API Authentication

  • Updated

General

The Clinch API is a REST API that utilizes key authentication for server-to-server use cases.

A Clinch API key corresponds to a single account, granting access to items and actions for that specific account. Furthermore, Clinch API keys have pre-configured access to specific API endpoints. These configurations are made according to the API endpoints you request access for in your support ticket.

Important: We don't recommend using the API on the client/browser side, as this can expose the API key to malicious activity from outside sources.

A few things to note about Clinch API authentication:

  • The API key doesn’t expire. 
  • Authentication for each API call is handled through the X-ApiKey header.
  • Each API call must contain an AccountId (https://publicapi.clinch.co/{AccountId}/…).

Getting your API Key

To obtain the API key for your account:

  1. Contact your Clinch account manager, customer success team, or open a support ticket requesting API access.
  2. Provide some of your use cases for the API and the API endpoints you want access to in your request.
  3. Clinch will respond to your request, providing your account-specific API key and account ID to use in API calls.

Modifying & Deleting Account API Keys

To add or remove endpoint access for your account API key, or to delete the key, contact your Clinch account manager, customer success team, or open a support ticket.