Bevatel API Documentation

Overview

The Bevatel API is organized around REST. Our API has predictable resource oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTPS response codes, authentication, and verbs.

Base URL

https://api.example/v1

Authentication

Bevatel uses Bearer Tokens to authenticate requests. You can view and manage your API keys in the Client Console. Your API keys carry many privileges, so be sure to keep them secure!

EXAMPLE HEADER

Authorization: Bearer YOUR_API_KEY

Rate Limiting

To maintain system stability, we enforce rate limits on all API endpoints. The default limit is 100 requests per minute per organization.

Name	Description
Retry-After	Number of seconds until you can retry the request
X-RateLimit-Limit	Number of requests allowed for this end point
X-RateLimit-Remaining	Number of requests remaining for this end point

TIP

Please Contact us if you would like to increase your rate limit.

HTTP Response Codes

Code	Status	Description
200	Ok	The request was successful.
201	Created	The request was unacceptable, often due to missing params.
400	Bad request	The request was unacceptable, often due to missing params.
401	Unauthorized	No valid API key provided.
403	Forbidden	The request was unacceptable, often due to missing params.
404	Not Found	Given the KPI Key used, the resource does not exist.
429	Too many requests	The request was unacceptable, often due to missing params.
500	Server Error	Something went wrong on our end.

Pagination

All top-level API resources have support for bulk fetches via "list" API methods. These list methods share a common structure, taking at least these two

Parameters	Description
Limit	A limit on the number of objects to be returned. Range: 1 to 100. Default: 10.
Offset	The number of items to skip before starting to collect the result set.

QUERY EXAMPLE

GET /v1/calls?limit=25&offset=50

This returns results 51 to 75. Pagination information is also returned in the response metadata object.