Authentication

Every request to the Sift API, whether using REST or gRPC, requires an API token for authentication. An example for REST and gRPC are as following:

curl -H "authorization: Bearer $API_KEY" $SIFT_REST_URL/api/v1/ping

The API URL depends on your provisioned environment and the chosen API type (REST or gRPC). Below are instructions on how to retrieve both your API token and URL.

Creating an API Token

Note: Certain parts of the images in this section are intentionally obfuscated.

Generate API tokens within Sift:

1. From any page in Sift, click the top-right user icon and select Manage.
2. On the manage page, select API Keys in the left column.
3. You will be directed to the API key generation page, which should appear as follows:
4. Complete the form by providing a name for your API key as well as your email:
5. After submitting the form by pressing Create API Key, a modal will appear containing your API key. The API key will be located in the area indicated by the red box in the following image.

Verifying Your API Token

You can test your newly generated key against the REST API using the curl command from your commandline or the gRPC API using grpcurl.

curl -H "authorization: Bearer $API_KEY" $SIFT_REST_URL/api/v1/ping

Retrieving your Sift URL

Your Sift URL can be found in the manage page of the web-application in the same page as where you generated your API token: