Authentication
To interact with the Sigmie API endpoints, your requests need to be authenticated.
This section will guide you through the authentication process.
We provide two methods for authenticating your API requests:
- Basic Authentication
- Authentication Headers
Basic authentication
With basic authentication, you use your application-id and api-key to authenticate your HTTP requests. Here's how to authenticate using cURL:
Example request with basic auth
curl https://${application_id}.sigmie.app/v1/health \
-H "Content-Type: application/json" \
-u ${application_id}:${api_key}
Authentication Headers
To authenticate your HTTP requests with authentication headers, you need to include the following headers in your requests:
| Header | Value |
|---|---|
| X-Sigmie-API-Key | { api-key } |
| X-Sigmie-Application | { application-id } |
Example request with headers
curl https://${application_id}.sigmie.app/v1/health
-H "Content-Type: application/json" \
-H "X-Sigmie-API-Key: ${api_key}" \
-H "X-Sigmie-Application: ${application_id}"
Always keep your api-key safe and reset it if you suspect it has been compromised.
Using an SDK
If you use one of our official SDKs, you don't have to worry — fetch your access token from the Sigmie dashboard under:
More -> API Keys
and the client library will take care of the rest.