Intégration API pour Ubigi for Business

Pour démarrer

Pour commencer l’intégration de nos APIs, veuillez lire cet article en premier.
Il explique comment obtenir vos identifiants et où trouver les valeurs techniques liées à votre offre dans le portail de gestion des SIM.

Passons maintenant aux détails concernant les API nécessaires pour gérer notre offre Ubigi for Business.

Activer vos SIMs

Le cycle de vie et les informations des SIM sont gérés via les API Connectivity Management API.
Ces API permettent :

• d’ activer des SIM,
• de modifier les services (appelés « options ») associés à vos SIM,
• de suspendre ou résilier des SIM,
• de renseigner des champs d’information tels que Référence ou Groupes pour organiser votre flotte,
• de récupérer les informations des services d’une SIM spécifique.

Pour activer vos SIM Ubigi for Business, vous trouverez tous les libellés techniques nécessaires dans le Portail de gestion des SIM, sous Catalogue > Options.

Vous aurez besoin:

• du plan tarifaire utilisé pour votre compte. Si votre compte est sur notre plan classique en Euros, la valeur sera M2MA_WW_TSL_MWC_1
• Les libellés techniques des options que vous souhaitez configurer pour les nouvelles SIM
  Cela inclut le choix entre le mode « pay-per-use » (paiement à l’usage) et les forfaits (bundles).
  Par exemple, pour activer une SIM avec le modèle tarifaire « bundles », vous devrez sélectionner UBGBUS_REF_BUNDLE dans votre appel API.

Voici un exemple d’appel à l’API d’activation pour une SIM en mode « forfaits Ubigi »

Pour garder votre interface synchronisée, vous pouvez recevoir les webhooks liés au cycle de vie des SIM.
Comme de nombreuses actions sont asynchrones (par exemple, il faut quelques minutes pour activer une SIM après l’envoi de l’appel d’activation), il est utile de recevoir des événements pour savoir quand une modification est terminée.

Les webhooks que vous pouvez recevoir sont détaillés ici.

Ajouter et gérer les forfaits

Pour tout maitriser sur les forfaits, il vous faudra les API suivantes:
– OCS Subscription
Il s’agit de l’API pour souscrire à un forfait

– OCS Inventory
Cette API vous permet de vérifier l’inventaire d’une SIM et son solde restant.
Utilisez cette API pour afficher le solde restant d’un forfait dans votre propre application ou interface.

– OCS Catalog
Cette API vous permet de récupérer tous les forfaits disponibles dans notre catalogue.

– OCS Events
Ce sont les événements Webhook liés au cycle de vie des produits (par exemple : expiration d’un bundle…).
Ils peuvent être utiles pour activer des notifications destinées à vos utilisateurs finaux ou dans votre propre interface.

Récupérer les informations d’une eSIM

Pour récupérer le code d’activation ou le QR Code d’une eSIM, utilisez l’API SIM Management API
Dans cet ensemble d’API, vous devez uniquement utiliser « Get eSIM details ».

Cette API permet de :

• récupérer le code d’activation, le lien de téléchargement du QR Code et le statut d’une eSIM,
• récupérer le statut de l’eSIM sur l’appareil – cela peut aider votre support lors du dépannage.

Les API « Reserve » et « Release » des profils ne s’appliquent pas à Ubigi for Business. Vos profils sont déjà dans le statut « Released

Valeurs spécifiques pour l’offre Ubigi for Business

Comme notre documentation API est générique, voici les valeurs à utiliser spécifiquement pour l’offre Ubigi for Business:

mvnoRef: le nom de votre compte Ubigi for Business, commençant en « M2MA_WW_TSL_….. »
Il s’affiche dans l’interface:


COS: cela correspond au catalogue de l’offre
La valeur à utiliser pour les comptes Ubigi for Business est WW_COS_UBG_MKP_EUR

Payment: s’agissant de forfaits qui seront rajoutés à votre facture mensuelle, la valeur à utiliser est « Customer« 

RatePlan
Le plan tarifaire est nécessaire pour l’utilisation des API Connectivity Management
Pour Ubigi for Business, si votre compte est en Euros, la valeur est M2MA_WW_TSL_MWC_1