Authentication

If we enforced authentication in this demo environment, it would be API key-based authentication. In this demo environment, please use the key below when necessary.

API key authentication

API key-based authentication involves sending an API key along with the request. The API key is a unique identifier that authorizes access to a specific region and is used to identify and track API usage.

To authenticate with an API key, the user or application needs only to include the API key as a query parameter or as a header in your request.

Here's how to authenticate with a query parameter using cURL:

API Key as a query parameter

curl https://demoapidocs.firstrate.com:8443/hello \
  -d x-api-key='secret_test_key'

Passing the API key in the request header using cURL:

API Key as a header

curl https://demoapidocs.firstrate.com:8443/hello \
  -H "x-api-key: secret_test_key"

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail in UAT and Production environments.

Request your unique API key

If you would like your own unique API key for access to your region, please reach out to your First Rate representative. Please don't commit your API key to GitHub! Always keep your key safe and reset it if you suspect it has been compromised.