Overview

Welcome to the Transatel APIs platform!


Transatel provides a suite of APIs that enable you to interface to Transatel platform and benefits of ours functionalities.

This site provides comprehensive documentation for all of our APIs and you will find everything you need to know about working with a particular API in the corresponding section.

However, there are some fundamental concepts that you need to understand and tools that might help you that apply across all our APIs. Here, we will give you this information and get you up and running as quickly as possible.

Concepts

All Transatel APIs are exposed through an API gateway, this gateway has the responsibility to enforce common concerns such as:

  • Authentication
  • Authorization
  • Rate limiting

Rest

Transatel APIs use HTTP verbs and a RESTful endpoint structure. You have to use GET HTTP requests in order to get information, POST HTTP requests to update/add data. Request and response payloads are in JSON format using UTF-8 encoding.

OpenAPI

All Transatel APIs descriptions are available in OpenAPI format so you can easily kickstart the integration of our services.

Authentication

Transatel APIs use as authentication mechanism OAuth 2.0 protocol with the client credentials grant.
This protocol provides an access token with permissions configured on your account which you can use on API request to authenticate yourself.
To connect a client_id and client_secret are necessary, those will be provided to you upon creation of your account. (For mode details see account management)

Eligibility

Transatel APIs provide an eligibility mechanism on all of its endpoints. This can be used to check which HTTP methods are accessible for a given URL by sending an HTTP OPTIONS request against it. The response will contain all available HTTP methods in the Allow header, as specified in the RFC 7231 .

Rate limiting

To prevent APIs to be overwhelmed by too many requests, the API gateway throttles requests to our APIs. Upon reaching the defined limit 429 Too Many Requests will be returned.
Quotas are defined per Transatel account, please contact your account manager to know more about it.

Webhooks

A webhook is a way to push real-time events to your platform. Those events are securely sent over HTTPS as JSON payload. All events are fully documented using OpenAPI 3.1 standard in our API references.

With Transatel webhooks, your integration is as easy as possible. You can decide which events to receive, where to send them and enable/disable them at any time. Also you can test your integration and simulate any events of your choice using our testing capabilities.

Depending on your needs, you can use webhooks to trigger any required BSS logic or even sends communications to your end users.

New to our world? Don't worry, we got your covered with our glossary.