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.
Quelques points clés pour démarrer :
– les eSIM Service Provider Connect sont ajoutées à votre compte au statut « préactivée ».
Vous n’avez donc pas à les activer, ni à faire de changement de statut – ajoutez juste le forfait souhaité, c’est tout !
– les profils eSIM sont déjà au statut « released », ce qui veut dire qu’elles sont prêtes à être téléchargées sur l’appareil de l’utilisateur final.
Vous n’avez qu’à leur fournir le code d’activation ou QR code – il n’y a aucune action à réaliser sur le profil.
APIs obligatoires:
– Authentication –
Utilisez cette API pour obtenir des tokens pour vos appels.
– OCS Subscription
Il s’agit de l’API principale pour l’offre.
Elle vous permet d’ajouter les forfaits aux SIMs.
Note: vous pouvez utiliser 2 types d’OrderType: « preload » and « subscribe ». Veuillez consulter le détail sur ce point plus bas.
API recommandées:
– SIM Management API
Dans cette collection d’APIs, vous n’avez besoin, et ne pouvez utiliser que l’API « Get eSIM details »
Cette API vous permet de :
* récupérer un Activation Code, le lien du QR Code download link,
* récupérer le statut de l’eSIM sur l’appareil de l’utilisateur (si elle est installée, activée, supprimée, ou pas encore téléchargée). Cela peut être utile pour votre support client.
Les API pour « Reserver » et « Releaser » des profils ne sont pas applicables à l’offre Service Provider Connect. Vos eSIM sont déjà réservées et released.
– OCS Inventory
Cette API vous permet d’obtenir l’inventaire d’une SIM et le solde restant sur les forfaits souscrits. Utilisez-là pour afficher le solde d’un forfait dans votre propre app pour interface.
– OCS Catalog
Cette API vous permet de récupérer tout le catalogue des produits disponibles.
Conseil pratique: pour obtenir les pays inclus dans un forfait, nous avons mis les destinations dans le champ « tags », au format ISO-2
–OCS Events –
Utilisez cette API pour recevoir des évènements Webhook liés au cycle de vie du forfait (ex: forfait presque épuisé, forfait expiré…). Cela vous permettra de faire vos propres notifications à vos utilisateurs.
API Optionnelles pour aller plus loin dans l’intégration:
– Subscription Management API
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 le statut de la SIM, voici les OrderType recommandés:
– Utilisez l’OrderType “Preload” si la SIM est au statut « Préactivée ». La SIM restera dans ce statut jusqu’ à son utilisation par l’utilisateur.
– Utilisez l’ OrderType “Subscribe” si la SIM est déjà active. « Preload » ne fonctionnera pas sur une SIM déjà active.
Dans les 2 cas, le forfait ne démarrera pas avant que l’utilisateur finale fasse du traffic dans un pays inclus dans le forfait!
Vous pouvez utilisez les exemples fournis dans l’OCS Products API reference pour trouver des contenus de requêtes avec les 2 OrderTypes: 