Table of Contents
Ubigi for Business API Integration
Getting started
This article will explain how to get started with integrating Transatel APIs to manage your Ubigi for Business offer.
We will summarize all required and recommended APIs, with the links on the Transatel Developer Portal and API references.
To start your API integration of our services, please read this article first.
It will explain how to get credentials, and where to find the technical values related to your offer in the SIM Management Portal.
Let’s now go into further details regarding the APIs required to manage our Ubigi for Business offer.
Activating your SIMs
The SIM’s lifecycle and informations are managed with the Connectivity Management API
These APIs are used to:
– activate SIMs,
– modify services (called “options”) for your SIMs,
– suspend or Terminate SIMs,
– populate information fields such as Reference or Groups to organize your fleet
– retrieve the information of the services of a specific SIM
To activate your Ubigi for Business SIMS, you will find all the required techical labels in the SIM Management Portal, in Catalogue > Options.
You will need:
- the rate plan used for your account
If your Account is on our standard plan in Euros, this reference should be
M2MA_WW_TSL_MWC_1 - The technical labels for the options you want to configure for the new SIMs.
This include choosing between pay-per-use and bundles
For example to activate a SIM on bundles pricing model, you will need to select UBGBUS_REF_BUNDLE in your API call.
Here is an example of an activation call for a SIM that will be on the Bundles pricing model:
Note: If you do not include a specific value for Pricing Model in your SIM activation, the SIM will be configured for Pay-per-Use Premium Networks as default value
In order to keep your interface synchronized, you may want to receive the webhooks related to the SIM’s lifecycle.
As many actions are asynchronous (ex: it takes a few minutes to activate a SIM after the activation call is sent), you may want to receive events to let you know when a change has been completed.
The webhooks you can receive are detailed here.
Adding and managing bundles
To fully manage the bundles, you will require the following APIs:
– OCS Subscription
This is the main API required for the service.
It will enable you to add the right bundles to your SIMs.
– 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
These are the Webhook events related to the product’s lifecycle (ex: bundle expired…). This is useful to enable notifications for your end-users, or in your own interface.
Retrieving the eSIM details
To retrieve the activation code or QR Code of an eSIM, please use the SIM Management API
In this set of APIs, you only need and only can use “Get eSIM details”
This API enables you to
* retrieve the Activation Code, QR Code download link, and status of an eSIM
* retrieve the status of the eSIM on the device – it can help your support with troubleshooting
The APIs to “Reserve” and “Release” profiles do not apply to Ubigi for Business. Your profiles are already reserved and released.
API specific values for Ubigi for Business
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_COS_UBG_MKP_EUR
Payment: 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
