Overview
NOTE: Using ClickBank API Keys may require a rudimentary understanding of computer programming. If you do not feel equipped to proceed, we encourage you to seek assistance from someone who has computer programming experience. All API users must agree to the ClickBank API contract.
As of July 27, 2023, API keys and API permissions are managed in the API Management section of your primary ClickBank account. To learn more about the difference between your primary account and your account nickname, check out this article.
Related: API Management Improvements & Additional User Permissions Added
In order to use ClickBank APIs, users must have the necessary API key and permissions. API keys are created, edited, and managed in the API Management section of the ClickBank primary account.
NOTE: Do not share your ClickBank API keys publicly. Redact all personal information and API keys when troubleshooting or sharing code online.
This article contains the following sections:
- How to Create an API Key
- Description of ClickBank APIs Available
- Using the Developer API Key
- Managing API Keys and Permissions From the Actions Menu
- Permissions "Quick View"
How to Create an API Key
Step 1: Log in to your ClickBank account.
Step 2: Click the Settings tab and then select API Management.
Step 3: Click Create New API Key and enter in a name for the API.
NOTE: Make sure the API Key Status toggle remains set to Active if you plan to use this API Key.
Step 4: Select which account nicknames that are linked to your primary account have access to which APIs using this API key. Use the All Accounts toggle to select all account nicknames for a particular API.
Step 5: Click Save.
Once you have saved the API key, it will be visible on your API key table.
Description of ClickBank APIs Available
ClickBank offers several unique APIs that can be used in a variety of integrations. All ClickBank APIs require a key and permissions, which are managed in the API Management section.
Analytics API
Related: Analytics API
The Analytics API contains analytics-related data for both sellers and affiliates.
Products API
Related: Products API
The Products API contains information about products that are in a particular account nickname. This API is only accessible to sellers.
Orders/Tickets API Read
Related: Orders API, Tickets API
Orders/Tickets API Read/Write
Related: Orders API, Tickets API
Subscription Modification API
Related:
Using the Developer API Key
Many ClickBank integrations require the use of the API developer key. This API key is located at the account nickname level. To retrieve and use this key, follow these instructions.
Step 1: Log in to your ClickBank account.
Step 2: Click the Accounts tab.
Step 3: Click the account nickname of the account you want to generate Developer API keys for.
Step 4: Click the Account Settings tab.
Step 5: Locate the Developer API Keys box and click Edit.
Step 6: Click Create New Developer Key.
Step 7: Provide a description to the developer key in the Description field. Note: The description is intended to help users keep track of their specific API keys in the Developer Keys table.
Step 8: Click Save.
Step 9: Copy the developer key from the Developer Keys table to use in integrations.
Managing API Keys and Permissions from the Actions Menu
You can regenerate, edit, or delete API keys from the API Management section of your primary account by clicking on the Actions menu next to each API key.
Regenerating API Keys
If you want to regenerate a specific API key, you can do so from the actions menu located next to each API key. NOTE: Regenerating an API key will break any existing integration using that API key.
Editing API Keys
If you want to edit API key permissions or change the name of an API key, select Edit from the actions menu. Once you have completed any necessary edits, click Save.
Deleting API Keys
To delete an API key, select Delete from the actions menu. NOTE: Deleting an API key is permanent and cannot be undone.
Permissions "Quick View"
Use the arrow icon next to each API key to quickly view which account nicknames have access to the APIs via the API key.
Additional Resources & Related Articles
- KNOWLEDGE BASE: How do I create additional users (aka clerks)?
- KNOWLEDGE BASE: How do I manage Clerk permissions?
- KNOWLEDGE BASE: ClickBank API Contract
- KNOWLEDGE BASE: ClickBank APIs