API Key - Jodoo - Open Platform

This article offers a comprehensive introduction to API Keys.

What is an API Key?

API Key is the name of a secret token assigned with a certain form. It is submitted with Web service (or similar) requests to identify the source of requests. API Key can be included in the summary of a request to further verify the source of the request and prevent tampering with these values.

How to Set up an API Key?

Step 1 Creating an API Key

1. Go to Open Platform > API Key, click API Key in the left panel, and you can create and set API Key.

2. Click Create API Key to add an API Key automatically.

Note:
1. Up to 500 API Keys can be created in each account.
2. Data of API Keys generated by the system cannot be updated.

3. API Key is hidden by default, but you can click to display it.

Step 2 Rename API Key

Click one created API Key, go to its details page, and you can rename this API Key to distinguish it from others.

Step 3 Setting the Scope

Click one API Key, go to its details page, and you can make settings on Scope (App) and Scope (API).

1. Scope (App)

There are two types of Scope (App):

If you select All Apps, all apps in Jodoo Workspace can use the API Key.
If you select Some Apps, only the apps added to the App List can use the API Key.

2. Scope (API)

There are two types of Scope (API):

If you select All APIs, all APIs in Jodoo can use the API Key, including Contact APIs, App APIs, Form APIs, Data APIs, File API, Workflow APIs, and CRM APIs.
If you select Some APIs, only the APIs added to the API List can use the API Key.

Step 4 Setting IP Whitelist

Once IP whitelist is set, open platform API will only be available for requests within it and other requests beyond it will be rejected.

Click one API Key and click New IP under IP Whitelist.

In the IP whitelist, you can set a single IP address or an IP address range. When setting an IP address range, You should add an asterisk (*) as a wildcard.

Note:
1. If no whitelists are set, any IP can use the corresponding API Key.
2. There is no limit for the total number of all IPs in the enterprise, but the number of IP whitelists in each API Key is limited. Up to 50 IPs in the whitelist can be added to each API Key.
3. IPv6 is not supported in IP whitelist.

Step 5 Enabling/Disabling an API Key

You can enable/disable the created API Key under Status. Disabled API Keys can be enabled again.

How to Copy an API Key?

1. Copying the API Key Value

You can click under API Key to copy the API Key value quickly for use.

2. Copying the Entire API Key

You can click under Action to copy the entire API Key. After copying, its scope and IP whitelist will be copied as well, but the copied API Key will have a new key value.

How to Delete an API Key?

You can click to delete unnecessary API Keys. For safety reasons, you can delete and create API Keys to change them regularly.

Note: You should ensure that the API Key is disabled before deleting it.