REST API
Authentication
Learn how to make authenticated requests to the REST API using an API key over HTTPS
Getting an API Key
Please contact [email protected] to request an API key.
Connecting to the REST API
Once our team has provisioned an API key, you can start making requests to our REST API over HTTPS. API Key authentication is done via HTTP headers. Example request:
Example response(with response headers):
Understanding Authentication Headers
Request Headers
x-api-key
You will use this header to pass your API key to our system for validation and authorization with every request. The key is a 32 character string we provision for you.
Response Headers
x-ratelimit-limit
This response header communicates the total number of requests you can make in a month. This limit is determined by conversations you have with our team at time of provisioning.x-ratelimit-remaining
As you make requests throughout the month this value will go down. You can use this value programmatically to, for example, alert your team of potentially a need for a higher limit or to self-throttle.x-ratelimit-additional-total
There are circumstances where, perhaps, you may need more requests than what was discussed with our team at time of API key provisioning. If you think this might happen on occasion, please bring this up with our team. When that happens, you will see this value increase with each request over the limit.x-ratelimit-reset
This header value represents the time in millisecnods when usage statistics will reset. This typically points to the end of the current month.