API Overview

Sift provides both a gRPC API and a REST API. Most services are available across both APIs, with only a few exceptions.

The choice between them depends on specific requirements:

  • REST API: Generally easier for initial implementation
  • gRPC API: Offers enhanced performance

While gRPC requires code generation from Sift's protocol buffers, client libraries are available for specific languages to streamline this process.

Both APIs require:

For details on obtaining these, refer to the Authentication Section.

Verifying a Connection

The following examples use curl and grpcurl to ping Sift's REST and gRPC API, respectively.

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