General
The Clinch API is a REST API designed for server-to-server use cases. Within your Flight Control account, the API Access section within Account Settings lets you create and manage credentials for programmatic access to Clinch's Public API.
Note: For authentication details and available endpoints, see the API documentation or the Swagger API Reference.
Authentication Methods
Clinch supports two authentication methods, both managed in the API Access section:
- OAuth Clients: Use a token-based authentication flow in which clients exchange credentials for temporary access tokens.
- API Keys: Use a static string-based authentication method in which the key is passed directly in the request header to authenticate each call.
Permission Groups
The following permission groups grant access to specific API functionality and endpoints:
- Google Ads Actions – Allows the client or API key to perform Google Ads-related actions through the Clinch API.
- Creatives – Allows the client or API key to create, retrieve, update, and manage creatives.
- Amazon – Allows the client or API key to access Amazon Ads integration endpoints.
- Feeds – Allows the client or API key to create, retrieve, update, and manage content, product, and location feeds.
- Notifications – Allows the client or API key to retrieve account notifications.
- Digital Assets Manager – Allows the client or API key to manage assets and folders in the Assets Library and Fonts Library, including uploading, downloading, moving, copying, deleting, and updating asset metadata.
Creating an OAuth Client
- Go to Account > Settings.
- Select the API Access tab.
- Click Add Client.
- The Create OAuth Client window opens.
- Enter a name for the OAuth client.
- Enter a description of the OAuth client.
- Click Add Permission and select the required permission groups. For details, see the Permission Groups section.
- Click Create.
- Copy the Client ID and Client Secret.
- Important: For security, the Client ID and Client Secret won't be shown again. If you lose them, you’ll need to create a new client.
The client is now created in Flight Control and ready to use in API calls. You can also create additional clients and delete existing ones.
Creating an API Key
To create a Flight Control API key:
- Go to Account > Settings.
- Select the API Access tab.
- Click Add API Key.
- The Create API Key window opens.
- Enter a name for the API key.
- Enter a description of the API key.
- Click Add Permission and select the required permission groups. For details, see the Permission Groups section.
- Click Create.
- Copy the API Key.
- Important: For security, the API key won't be shown again. If you lose it, you’ll need to create a new key.
The key is now ready to use in API calls. You can also create additional API keys and delete existing ones.
Note the following about Clinch API authentication:
- The API key doesn’t expire.
- Authentication for each API call is handled through the
X-ApiKeyheader. - Each API call must contain an account ID:
https://publicapi.co/{Account_ID}/…