API Key
An API Key is a token that is used to authenticate requests to access our APIs. Alternatively, it is a unique code that helps the developers interact with the data and functionalities of Zoho Campaigns Email API.
It is similar to OAuth 2.0 access token. The difference is that an API Key never expires, whereas an OAuth 2.0 access token expires and needs to be refreshed frequently.
API Key can be considered as an alternative authentication method to OAuth 2.0. You'll use it when calling the APIs of Zoho Campaigns Email API. Learn more about API Key authentication here.
Creating an API Key
To create an API Key:
- Click API Keys from the Navigation Toolbar to the left.
- At the top-right corner, click Create API Key.
- In the slide-in window that appears, provide the API Key Name.
- Select the Scope, then click Create.
Purpose of creating multiple keys:
You may have wondered why even though an API key doesn't expire, there is an option to create more than one key.
You may have wondered why even though an API key doesn't expire, there is an option to create more than one key.
A maximum of 20 keys can be created by a single user.
You can create multiple keys for your own reference.
For example, one key can be used specifically for making API calls and another key can be used for SMTP authentication.
In fact, API Key is user-based. If more than one user is present in your Zoho Campaigns Email API organization, the keys created by User A can't be viewed by User B and vice-versa inside this module.
Note: Since an API key never expires, it can be exposed and misused. In such instances, it is highly recommended to delete the keys from the API Keys module to prevent further unauthorized access. Thus, we strongly advise you to store the API keys securely and avoid sharing them. In case a key is shared temporarily, ensure it is deleted after its usage. You can create new keys after that.Deleting an API key
To delete an API key:
- Click API Keys from the Navigation Toolbar to the left.
- Click the trash icon on the right and choose Delete.
Once a key is deleted, it cannot be retrieved. You need to create a new key.