Introduction
We can’t wait to see what you build with Contiguity’s API.
Getting Started
Use of Contiguity’s services requires an account to be made with Contiguity. This, apart from needing a connection to the internet, is all you need to begin using Contiguity.
The API accepts both JSON and form-encoded data. Make sure you set the Content-Type
header.
Base URLs
When sending requests, the base URL for your requests will likely be:
However, for some data or requests, you may encounter base URLs such as:
We’ll let you know if you’re sending a request to a base URL different from api.contiguity.co
.
Authentication
When using the API, attach an X-API-KEY
header that’s equal to Token YOUR_TOKEN_HERE
in each request.
Authentication is required for most endpoints Contiguity provides.
API Best Practices
Avoid “spamming” the API
While Contiguity’s API can scale and is meant to handle millions of requests, it still rate limits users beyond a certain amount of requests per second. Avoid, for example, polling /otp/verify
with every digit your user types - instead wait for all 6 digits before requesting verification.
Respect local laws
Contiguity was designed to not be required to follow certain ‘regulations’, i.e A2P 10DLC registration in the US. However, it is still up to you, the user, to follow all laws applicable to you (i.e, in the US, CAN-SPAM) - not Contiguity’s.
Compliance
Contiguity has launched Contiguity Compliance, an Enterprise service meant to take the burden of managing compliance with privacy/communications laws.
Secure your tokens at all times
It is advisable to never use your account token in production. You can generate throwaway tokens in the dashboard, that can easily be revoked in the end of misuse by an unauthorized third party.
Account Token Leak
If your account token leaks, your only option to mediate the situation is emailing help@contiguity.support immediately.
API Status
Contiguity strives for >99.98% uptime. In the event Contiguity begins to return any 5xx
error, check Contiguity’s status page. If an incident hasn’t been marked as Investigating
, please notify Contiguity immediately via email (help@contiguity.support) or Discord