FAQ

Having some questions? Let's find out if we got you covered!

Authentication

How can I get my credentials?

If you are already signed on a Transatel offer, your account manager will provide those to you else you can contact our sales team which will be happy to organize a demo for you.

Which authentication protocol do you support?

Today only OAuth2 which is an industry standard is supported with client_credentials grant.

I can't connect even with valid credentials, why?

Be careful when providing your credentials to retrieve your access_token, to properly compute the Authorization header. It should be the Base64 value of the concatenation of your client_id and client_secret separated by a colon (:).

Should I retrieve an access_token for every API request?

No, as mentioned in the authentication guide, access_token should be renewed only after expiration.

Should I implement this token renewal by myself?

Usually most frameworks and libraries supporting OAuth2 will do that automatically.

Connectivity Management

Where to find my manageable options?

For subscriber activation or modification, you may need to retrieve the list of available options. For that, you will need a user account in order to access the SIM management portal. Once logged into our SIM management portal, navigate to Catalogue > Options. You will need to use the “option name” in your requests.

Where to find my rate plan?

You can find the rate plan in the SIM management portal in Catalogue > Options. Rate plan is a mandatory parameter for subscriber activation or modification. Depending on your specific offer, you may have one or several rate plans.

OpenAPI

Can I only use Postman?

No, every API exposes an OpenAPI specification that can be downloaded from its API reference page. This service definition is a standard supported by many tools which will help you on many aspects like testing, generating client code and mocking (See https://openapi.tools).

Which version of OpenAPI do you support?

Our APIs expose an OAS 3 specification (See https://swagger.io/specification).

Do I need to use your Postman collection?

Absolutely not, you are free to use our APIs directly or with any tool of your choice. Those collections are just an easy way to get you started. Also if you are looking for request examples, our APIs reference pages content examples for each operation.

Can I modify your Postman collection?

Of course, once imported in your Postman workspace you are free to do all the changes you need.

OCS

In which timezone dates are expressed?

All dates are expressed in ISO-8601 and in UTC.

Which payment provider should I use?

This depends on the type of service offered, and the contract signed with Transatel. Still unclear? Please contact your account manager.

In which case should I retry a failed request?

Please find below some general guidelines:

  • 4XX: Means generally that the request cannot be processed either because it is incorrect or the current situation does not permit it.
  • 403: If you receive such error even with a proper access_token, then you don't have access to this API or your access is restricted. Please contact our support to check your credentials.
  • 5XX: Means generally that a temporary technical issue occurred and that you can retry later on.

For a list of possible HTTP statuses and error code, please refer to our APIs reference pages.

Webhooks

Can I configure an HTTP endpoint ?

No, to ensure the security of the solution only HTTPS endpoint are supported.

What should I do if my endpoint HTTPS URL change ?

If your public endpoint HTTPS URL changes, you can update it by using the update webhook operation (See our API reference for more details). This change will be taken into account immediately for any new events.

How to subscribe to new events ?

If you need to subscribe to new events, you can update the list of subscribed events on your webhook by using the update webhook operation (See our API reference for more details). This change will be taken into account immediately for any new events.

Should I use a secret ?

This is our recommendation since it will allow you to verify that any received events are indeed coming from our platform. However defining a secret on your webhook is not enough, you will need of course to validate the signature of events you receive. To know more about it, please check our integration guide.

How many webhooks can I configure ?

Defining a single webhook is generally enough for most use cases. However, we offer you the possibility to define up to 10 webhooks if you have more specific use cases like for example routing different events to different sub-systems on your platform.

Please be aware that if you leave some configured webhook active but targeting some obsolete and unavailable endpoints, we may disable those webhooks.

What if my platform is unavailable ?

Don't worry, our automatic retry mechanism will try to deliver the events again. Be aware however, that we will stop retrying if you stay unavailable too long!