How to integrate our APIs?

How to integrate our APIs?

Our APIs let you manage your SIMs from your own tools: activate them, change their services, follow their consumption and automate your workflows. This article covers the basics you need before you start any integration, whatever your offer.

Where to find API documentation

All API resources are on the Transatel Developer Portal. There you will find:

• integration guides, which explain how to combine our APIs for common use cases;
• the API reference, with the endpoints, parameters and example requests.

For the steps specific to your offer, see the dedicated integration article in this section (for example, IoT Connect Capped Plans API integration).

How to get API credentials

API credentials are created with your account if you asked for them. Otherwise, contact your account manager or service manager.

Two ways to configure your SIMs’ services by API

When you activate a SIM or change its services, you can configure it in two ways.

1. With a service profile (recommended)

A service profile is a ready-made set of services (pricing model, data, SMS, options…) defined in the SIM Management Platform. It works the same way as in the interface: you pass the service profile reference in your API call, and the SIM gets every service in that profile.

Why this is the recommended approach:

• Simpler: one value to pass instead of a list of options.
• Consistent: SIMs activated by API get the same profile as SIMs activated in the interface. To change their services, just assign them another profile: they are not marked as deviated.
  But changing a SIM’s options one by one marks it as deviated from its service profile in the interface.
• Easier to manage: SIMs are sorted by service profile in the SIM Management Platform, so you can filter them, check them and update them as a group.

2. With a rate plan and options (advanced)

You pass the rate plan and the technical label of each option you want to enable. This gives you full control over each service, SIM by SIM, but:

• you have to keep the list of options in your integration up to date;
• the SIMs are not linked to a service profile in the interface.
• Changing a SIM’s options one by one marks it as deviated from its service profile in the interface.

	Service profile	Rate plan + options
What you pass	One service profile reference	Rate plan + one technical label per option
Consistency with SIMs activated in the interface	Same profile	SIMs are not linked to a profile
Sorting in the SIM Management Platform	By service profile	Not grouped by profile
Best for	Most integrations	Very specific per-SIM configurations

How to find the values to use in your API calls

• Service profiles: in the SIM Management Platform, go to Catalogue > Service profiles . Use the profile reference shown there
• Rate plans and options: go to Catalogue > Options. This menu lists the exact technical labels to pass in your API calls for each option. If your account has several rate plans, pick one from the drop-down list.

Need help?

Contact our support team via the Service Desk.