Overview
NOTE: Using 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.
Before proceeding, we recommend that all users who want to complete integrations or use API Keys have a primary ClickBank account (aka "master account").
In order to use ClickBank's APIs, you must have the necessary API key. There are two types of API keys: clerk and developer. Each key can be used to grant specific roles to account users.
- Clerk Key
This is a key for a specific user. It grants one or more of the following roles: read, write, analytics, products, subscription modification.
- Developer Key
This key grants access to the API for your account. This key is required for all ClickBank APIs.
NOTE: Do not share your ClickBank API keys publicly. Redact all personal information and API keys when troubleshooting or sharing code online via websites like Pastebin or Stack Exchange.
This article contains the following sub-articles. Click the hyperlinked title to navigate to the section that best suits your needs.
- How to Generate a Clerk API Key
- How to Generate an a Developer API Key
-
How to Manage API Access & Clerk Keys Without Deleting an Existing Clerk Key
How to Generate a Clerk API Key
This set of instructions pertains to Clerk API keys only. Users cannot generate a developer API key without accessing the nickname account interface of a specific nickname account. To generate a developer API key, follow the instructions in the How to Generate a Developer API Key section.
Related: How do I sign up for a ClickBank account?
Step 1: Log in to your ClickBank account.
Step 2: Click the Users tab.
Step 3: Select the user from the table that you wish to create a new clerk API key for and click the Manage Permissions link.
Step 5: Locate the user's API key.
Step 6: Copy the API Key. Click Regenerate if you wish to create a new API key.
NOTE: There is no need to regenerate an API key if you already have one. Doing so will invalidate the current key and can cause accuracy issues with any data accrued with the previous key.
Step 7: Manage which APIs specific users can access from this page by checking the boxes under the Third Party Integrations heading.
How to Generate a Developer API Key
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.
How to Manage API Access & Clerk Keys Without Deleting an Existing Clerk Key
The benefit of allowing access to a Clerk API key over creating a new API key for every integration or a new User for every integration is that it minimizes the risk that you will break integrations by regenerating Clerk API keys. When the Clerk API key (primary account level) is matched with the Dev API Key (nickname account level), integrations can function properly.
Step 1: Log in to your ClickBank account.
Step 2: Click the Users tab.
Step 3: Locate a user from the User Management table and click Manage Permissions.
Step 4: From the Permissions page, check the nickname accounts you want to have access to this particular Clerk API. From those particular account nicknames, you can generate a dev API key to complete integrations.
Step 5: Click Save.
Additional Resources & Related Articles
- KNOWLEDGE BASE: How do I create additional users (aka clerks)?
- KNOWLEDGE BASE: How do I manage Clerk permissions?
- KNOWLEDGE BASE: What is a Master Account?