Ubigi for Business API Integration

This article explains how to integrate our APIs for the Ubigi for Business offer.

Before you start: read How to integrate our APIs? to get your credentials and find your service profiles and technical values in the SIM Management Platform. API links and references are on the Developer Portal.

1. Activate your SIMs and manage their services

API: Connectivity Management

Use this API to activate, suspend or terminate SIMs, change their services, fill in reference and group fields, and read a SIM’s service information.

Recommended: use service profiles

Create or pick a service profile in the SIM Management Platform, then pass its reference in the activation request. The SIM gets the profile’s pricing model and services, and appears under that profile in the interface, exactly as if you had activated it there.

POST /api/subscribers/sim-serial/{simSerial}/activate
{
  "serviceProfile": "<your service profile reference>",
  "externalReference": "Device-0001",
  "group": "Group A1"
}

💡 To change a SIM’s services, assign it another service profile. The SIM takes on the new profile’s configuration and is not marked as deviated. It stays aligned with its profile and sorted correctly in the interface.

Alternative: use a rate plan and options

If you need a specific configuration for each SIM, pass the rate plan and the technical label of each option. You will find all rate plans and option labels in the SIM Management Platform, in Catalogue > Options.

For example, to activate a SIM on the bundles pricing model with a standard EUR account, set the option UBGBUS_REF_BUNDLE to on:

{
  "ratePlan": "M2MA_WW_TSL_MWC_1",
  "options": [
    {
      "name": "UBGBUS_REF_BUNDLE",
      "value": "on"
    }
  ]
}

⚠️ Changing a SIM’s options one by one marks it as deviated from its service profile in the SIM Management Platform. To change services without deviating your SIMs, assign them another service profile instead.

⚠️ If no pricing model is set, the SIM is configured on Pay-per-Use Premium Networks by default.

Good to know:

• Each option has a default value if you don’t set it.
• Some options accept only one value, like a drop-down list in the interface.

2. Retrieve your SIM list

API: SIM Search

Search, filter, sort and paginate your SIMs. Typical uses include inventory dashboards, customer portals, internal tools, retrieving SIMs by account or group, and customer care and troubleshooting workflows.

Many actions are asynchronous (an activation can take a few minutes). Subscribe to Connectivity Management Events (webhooks) to be notified of lifecycle changes.

3. Add and manage bundles

API	What it does
OCS Subscription	Adds a bundle to a SIM. This is the main API for this offer.
OCS Inventory	Shows a SIM’s bundles, subscription status and remaining balance, for example to display it in your interface.
OCS Catalog	Lists the available bundles.
OCS Events	Sends webhooks on bundle lifecycle events (for example, a bundle expiring), for end-user notifications or interface updates.

💡 To find bundles by country, use the tags field of OCS Catalog: it lists the countries covered by each bundle, in ISO-2 format.

4. Retrieve eSIM details

API: SIM Management, Get eSIM details endpoint only

This endpoint returns the activation code, the QR code download link, the eSIM status and the device status (useful for troubleshooting). The Reserve and Release profile APIs do not apply to Ubigi for Business: your profiles are already reserved and released.

5. Retrieve data usage

• OCS Inventory: bundle details, remaining balance and expiry date for SIMs with a bundle.
• Network Usage: total data usage for all SIMs over a given period, filterable by country and date. Especially useful for SIMs on pay-per-use.

Glossary – values for Ubigi for Business

Our API documentation is generic and doesn’t list the values specific to each offer. Here are the ones to use for Ubigi for Business.

Value	Used in	What to enter
serviceProfile	Connectivity Management (activation, service change)	Your service profile reference, from Catalogue > Service profiles
mvnoRef	OCS APIs	The name of your Ubigi for Business account, format M2MA_WW_TSL_…, shown in the SIM Management Platform
COS (Catalog of Services) to get the bundles	OCS Catalog	Production: WW_COS_UBG_MKP_EUR
payment	OCS Subscription	Customer (you, as a Transatel customer, pay for the bundles)
ratePlan	Connectivity Management (rate plan + options method) and the optional Subscriptions Management API	Your rate plan, from Catalogue > Options (for example, M2MA_WW_TSL_MWC_1 for a standard EUR account)

Need help?

Contact our support team via the Service Desk.