API Authentication

Understand how CleverTap authenticates API requests

Overview

CleverTap uses a header-based authentication model to authenticate requests to the API. Every CleverTap API call should include Account ID and Account Passcode as the request headers. If your CleverTap admin has opted for User-Passcode instead of Account Passcode, you must use your User-Passcode in the X-CleverTap-Passcode header. The CleverTap API expects these values to be keyed in as X-CleverTap-Account-Id and X-CleverTap-Passcode.

Obtain Your Account Credentials

To obtain your account credentials, refer to Get CleverTap Account Credentials.

Example cURL Request

Here is an example cURL request to the Events API showing the headers needed to authenticate the request from the account in the India region.

curl "https://in1.api.clevertap.com/1/events.json?cursor=CURSOR_VALUE" \
-H "X-CleverTap-Account-Id: YOUR_ACCOUNT_ID" \
-H "X-CleverTap-Passcode: YOUR_ACCOUNT_PASSCODE OR YOUR_USER_PASSCODE" \
-H "Content-Type: application/json"
require 'net/http'
require 'uri'
uri = URI.parse("https://api.clevertap.com/1/events.json?cursor=CURSOR_VALUE")
request = Net::HTTP::Get.new(uri)
request.content_type = "application/json"
request["X-Clevertap-Account-Id"] = "YOUR_ACCOUNT_ID"
request["X-Clevertap-Passcode"] = "YOUR_ACCOUNT_PASSCODE"
req_options = {
  use_ssl: uri.scheme == "https",
}
response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end
puts response.body

For more information on the API endpoints for the region of your account, refer to CleverTap Regions.

Account Passcode Vs User Passcode

There can be situations where it becomes risky to give away the account passcode of your CleverTap account to people inside and outside your organization. It exposes your account to security risks. Therefore, granting user passcodes to specific users using CleverTap APIs instead of account passcodes is best.

Account-Level Passcode

You can have multiple account-level passcodes rather than having a single account passcode used across different partners. This offers better security when using CleverTap APIs.

Account passcodes can be unique to each partner. Only admins or users with write access to the User Settings page can grant passcodes. They can create up to 100 passcodes.

Create Account Passcode

To create an account passcode:

  1. Navigate to Settings > Passcodes.
  2. Click + Passcode.
2722

Generate Passcode

  1. The Generate Passcode page displays.
630

Add Passcode Details

  1. Enter the following details:

Field

Description

Passcode Name

Enter the name to uniquely identify the passcode.

Set Expiry Date

Select from the available options:

  • Set day(s): Enter the number of days after which the passcode will expire.
  • Forever: Select this option if you do not want the passcode to expire.
  1. Click Create & View. On clicking, the passcode displays.
  2. Click API Key to copy it and then click Done.

πŸ“˜

Save Passcode

For security reasons, the passcode cannot be shown again. Copy the key and save it for later use.

  1. The new passcode is now visible under the Passcodes page.

πŸ“˜

Passcode Expiry

  • An email notification is sent when the passcode is nearing expiration or has expired.
  • The passcode status is displayed as Expiring soon from the 30 days of expiration.
  • An error message displays when using the expired passcode to authenticate with CleverTap API.
  • After the passcode expires, we recommend deleting the passcode.

Edit Account Passcode

To edit account passcode:

  1. Navigate to Settings > Passcodes and then click Edit icon for the passcode you want to edit. The Edit Passcode page opens.
578

Edit the Existing Passcode

  1. Modify the required fields and then click Update.

Delete Account Passcode

Navigate to Settings > Passcodes and then click Delete icon for the passcode you want to delete. On deleting the passcode, the APIs will stop working.

User Passcode

For API authentication, you can enforce dashboard users to use user passcode rather than account passcode. User passcode offers a better security standard while using CleverTap APIs.

User passcodes are unique to each user and granted by the admin.

Enable User Passcode for a User

  1. If you are an admin user, go to Settings > Users to enable the user passcode.
  2. Select the user from the list and click Grant.
2284

Enable User Passcode

When you grant the passcode to a user, you need to specify the period for which the passcode remains valid.
You can specify the period from the following options:

FieldDescription
FiniteIndicates that the passcode can be valid for a specific period (1-365 days).
InfiniteIndicates that the passcode is valid for up to 10 years.
  1. After you grant the user a user passcode, the users can see their user passcode on the Settings page, as shown below:
View User Passcode

View User Passcode

Reset and Revoke User Passcode

An admin can reset or revoke an existing user passcode by navigating to the Users page and selecting the required action.

  • Reset Passcode generates a fresh new passcode for the user. Post resetting, the user has to incorporate the new passcode into APIs.
2284

Reset User Passcode

  • Revoke Passcode invalidates the existing passcode for the user, and the user can no longer fire API calls using their passcode.
2284

Revoke User Access to the Passcode

Next Step

Now that you understand how to authenticate with the CleverTap API, you are ready to make your first API call.

Start with Get User Profiles API, which shows you how to request User Profiles from CleverTap.