Service Provider Connect API integration

This article will explain how to get started with integrating Transatel APIs to manage your Service Provider Connect service.
We will summarize all required APIs, with the links on the Transatel Developer Portal and API references.
Please check out this article first to learn about our APIs.

Transatel offers many APIs, but you can get started with easily with a few of them.

Authentification API

Transatel API use  OAuth 2.0 authentification.

Use the Authentication to get access tokens

OCS APIs (subscription, catalog, inventory)

These are the main APIs required for the service.
It will enable you to add the right bundles to your SIMs, retrieve the catalog, and check the inventory.

– OCS Subscription
This API will enable you to add the right bundles to your SIMs.
Important note: you can use 2 types of OrderTypes : “preload” and “subscribe”.
Service Provider Connect SIM cards & eSIMs are delivered to you in Preactivated status. They will automatically activate at the first network attach. (The lifecycle of Service Provider Connect SIMs is detailed here).

Based on the SIM’s status, here is the recommended OrderType to use:
– Use the OrderType “Preload” on Preactivated SIMs –> the SIM will remain preactivated until it is installed and used by the end-user
– Use OrderType “Subscribe”, on Active SIM cards –> you cannot preload a plan on an active SIM Card.
In both cases, the data plan will not start until the SIM is being used in a location covered by the plan.


You can use the examples provided in the OCS Products API reference to find payload requests with the different values :

– OCS Inventory
This API allows you to check a SIM’s inventory and remaining balance. Use this API to display the remaining balance of a plan in your own app or interface.

– OCS Catalog
This API allows you to retrieve all available products in our catalogue.
Tip: to check bundles by location, we include the locations covered in a bundle in the “tags” field, in ISO-2 format.

– OCS Events
Use this API to receive Webhook events related to the product’s lifecycle (ex: bundle expired…). This is useful to enable notifications for your end-users.

SIM Management

Important note on SIM/eSIM Management in the Service Provider Connect offer

Our service provides you with your own stock of eSIM profiles to manage.

We do not provide an API to get new profiles on demand, instead you are required to keep your own database of profile and manage your stock.

You can update your stock by:

• importing the SIM delivery file provided with each new SIM order
• importing the daily Subscription report, made available on your SFTP account

SIM status and eSIM installation status

There are 2 separate lifecycles to keep track of a SIM/eSIM:

• The SIM status

This refers of the telecom status of the line. For example, a line needs to be active to work, and a can be suspended to stop traffic.

If a customer decides to no longer use the service, you can terminate the line.
In Service Provider Connect, we deliver the SIMs in preactivated status, so no action is required on your side to activate them.

• The eSIM status

This status is only for eSIM profiles, and refers to the status of the eSIM profile on a device.

For example, an eSIM can be “downloaded”, “installed”, “enabled” or “deleted” from a device

In Service Provider Connect, we deliver the SIMs in “released” status, so here again no action is required on your side to get them ready for end-users (apart from adding a bundle)

The 2 lifecycles work in parallel, but to work, the SIM must be in:

• active status,
• enabled on the device

eSIM Details API

As the eSIMs are ready to be used, the only API useful for the Service Provider Connect service is the “Get eSIM details” API, that allows you tor retrieve the Activation code / QR code and the installation status on the device

Connectivity Management APIs (optional)

Subscription Management API
As mentioned above, Service Provider Connect SIM cards are preactivated, Therefore you are not required to integrate our Subscription Management APIs, to activate the SIM cards. They will automatically activate at the first network attach.
You can however still integrate them if:
– you wish to Suspend or Terminate SIMs,
– you would like to populate information fields such as Reference or Groups to organize your fleet, as these dimensions can be found in our SIM Management Portal
If you would like access to our Subscription Management APIs, please check with your Account Manager to request access, as we usually do not open by default them for Service Provider Connect customers.

Service Provider Connect specific API glossary

As the API documentation is generic and does not list offer-specific values, here is everything you need to know:

mvnoRef: the name of your SPC account, and starts with “M2MA_WW_TSL_…..”
You can find it easily in our SIM Management Platform:


COS: this refers to the catalog of the offer.
The value for production accounts is WW_M2MA_COS_SPC

Payment: for Service Provider Connect, as you – Transatel’s customer- are paying the bundles to Transatel, the value to input in the subscription requests is “Customer“

RatePlan
This is a value required only if you are planning to use the optional Subscriptions Management API.
You can find your RatePlan in the SIM Management Plaftorm in Catalogue > Options