Api Overview
Base URL
Authentication
TokenChannel controls access to the API features and data via an API Key. Also your usage is recorded and reported via the API Key.
Sign up and your new account will be created with a default subscription to our SANDBOX plan. An API Key token is going to be automatically created for you and you will be able to copy it in the user's dashboard.
To consume our API endpoints, you need to provide your personal api key in every request as the value for the X-Api-Key header:
curl -X POST -H "X-Api-Key:0A1DF47A9D266B6C8E6D57EA71F5E4E7" http://api.tokenchannel.io/sms/%2B14155552671
Remember to keep your API key private so you can prevent against unauthorized use of your account.
Remember you will be able to reset the API key at any time you consider it could be compromised in the user's dashboard.
HTTPS / SSL
Endpoints of our API work over a secure HTTPS connection for all users, even for the SANDBOX plan.
Make sure to use https:// in every API request.
Rate Limits
Requests to the API are rate limited.
Remember If any rate limit have been exceeded, the API will return a
429 - TOO_MANY_REQUESTSstatus code.
Rate limits that apply for every plan
Queries per second (QPS) is rate-limited to 6.
Queries per minute (QPM) is rate-limited to 400.
Important In order to ensure maximum API performance, we recommend all users to limit their usage to a maximum of 5 API requests per second.
Rate limits that apply only for SANDBOX subscription
For SANDBOX subscription there is a monthly rate limit: 200 requests per month.
A SANDBOX customer is going to receive a
X-RateLimit-Remainingheader in the response with the remaining requests count in the period.
Common API Status Codes
TokenChannel uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, an invalid format, etc.). Codes in the 5xx range indicate an error with TokenChannel's servers (these are rare).
Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported.
| HTTP STATUS CODE | SUMMARY |
|---|---|
| 200 - OK | Everything worked as expected. |
| 400 - Bad Request | The request was unacceptable, often due to missing a required parameter or invalid value. |
| 401 - Unauthorized | No valid API key provided |
| 403 - Forbidden | The API key doesn't have permissions to perform that request. |
| 404 - Not Found | The requested resource doesn't exist. |
| 429 - Too Many Requests | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. |
| 500, 502, 503, 504 - Server Errors | Something went wrong on TokenChannel's end. |
Postman Collection
You can play around with the endpoints used in the tutorial with Postman