Intégration API

Cet article explique comment démarrer une intégration des API Transatel pour la gestion de l’offre Service Provider Connect.
Nous détaillerons les méthodes API nécessaires, avec les liens vers le Transatel Developer Portal et les références API. 

Transatel met à disposition plusieurs types d’APIs, mais vous pouvez démarrer une intégration basique de l’offre Service Provider Connect avec seulement 2 types d’API.   

 
APIs obligatoires:
– Authentication – comment obtenir des tokens
– OCS Subscription – l’API permettant d’ajouter et de gérer les forfaits ajoutés aux SIMs, 
 
API Optionnelles pour aller plus loin dans l’intégration:
– SIM Management API – Pour récupérer le Code d’Activation, le lien de téléchargement du QR Code, ainsi que le statut de l’eSIM. 
– OCS Inventory – Pour obtenir l’inventaire d’une SIM et le solde restant sur les forfaits souscrits. 
– OCS Events – Pour recevoir des évènements Webhook liés au cycle de vie du forfait (ex: forfait presque épuisé, forfait expiré…)

Concernant l’API Subscription Management 
Comme détaillé dans le cycle de vie des SIMs Service Provider Connect, les nouvelles SIMs sont préactivées.
De ce fait, il n’est pas nécessaire d’intégrer l’API Subscription Management, qui permet d’activer les cartes SIMs. Elles s’activeront automatiquement à la première attache réseau. 
Vous pouvez cependant l’intégrer si :
Vous souhaitez suspendre ou résilier des SIMs
Vous souhaitez renseigner des ifnormations telles que la Référence ou le Groupe pour organiser votre flotte – comme ces champs sont disponibles dans notre Plateforme de gestion de SIMs. 
 
Si vous souhaitez intégrer les API Subscription Management, nous vous invitons à contacter votre responsable commercial, car nous n’activons pas l’accès à cette API par défaut aux clients Service Provider Connect.

Notre documentation API étant générique, et ne spécifiant pas les valeurs liées à une offre, voici tout ce que vous devez connaitre:

mvnoRef: il s’agit du nom de votre compte Service Provider Connect, et commence par « M2MA_WW_TSL_…..”
Vous pouvez le retrouver dans noter interface:



COS: Il s’agit du catalogue de l’offre. La valeur pour les comptes de production est WW_M2MA_COS_SPC

Payment: pour Service Provider Connect, comme vous – en Client de Transatel – paierez les forfaits à Transatel, la valeur à passer dans les requêtes de souscription est “Customer“

OrderType ;
Les SIM Service Provier Connect que vous recevez sont au statut « préactivé ». Elle s’activeront automatiquement à la première attache au réseau. (Le cycle de vie des SIMs est détaillé ici)

Selon l’OrderType utilisé dans la requête, l’activation du forfait change:
– Si vous utilisez OrderType “Preload”, le forfait sera pré-chargé sur la SIM, et ne s’activera pas avant l’activation de la SIM.
Cela peut être utile si votre utilisateur final achète son forfait avant de voyager, et n’installera la SIM qu’une fois arrivé à à la destination où il sera utilisé. Cela évite de perdre des jours de validité
Note: Ce type ne peut être utilisé que si la SIM est au statut préactivée. Pour une SIM déjà active, il faut absolument utiliser l’OrderType « Subscribe » détaillé ci-dessous.
– Si vous utilisez l’ OrderType “Subscribe”, le forfait sera ajouté et activé immédiatement sur la SIM, et cela déclenchera son activation si elle est au statut préactivée.

Note: Si vous utilisez notre Plateforme de Gestion de SIMs pour l’ajout des forfaits, l’interface ne propose pour l’instant que l’OrderType « Subscribe », et l’ajout d’un forfait sur une SIM préactivée déclenchera immédiatement l’activation de la SIM et du forfait. (L’OrderType « preload » arrive bientôt dans l’interface!)

Vous pouvez utilisez les exemples fournis dans l’OCS Products API reference pour trouver des contenus de requêtes avec les 2 OrderTypes: