Authenticate with the REST API

Overview

Every request to the REST API must be authenticated to ensure secure access to your data and services. Authentication requires two components, both of which must come from the same provisioned environment:

• A base URL that identifies the REST API server you are connecting to.
  • You can find the appropriate base URL for your project in the Sift UI when generating an API key.

    To learn how to create an API key in the Sift user interface, see Create an API key.

• An API key that serves as your secure credential.
  • You can generate an API key through the Sift web application or programmatically via the Sift API.

    To learn how to obtain the base URL for REST/gRPC requests, Obtain the base URL for REST/gRPC requests.

Instructions

To authenticate with the REST API, consider the following steps:

1. Create an API key.
2. Obtain the base URL for REST requests.
3. Replace the placeholders ($SIFT_API_KEY and $SIFT_REST_BASE_URL) in the following command with your actual values:

   curl -H "authorization: Bearer $SIFT_API_KEY" $SIFT_REST_BASE_URL/api/v1/ping