Service Provider Connect API integration

Cet article explique comment commencer à intégrer les API Transatel pour gérer votre service Service Provider Connect.
Nous résumerons toutes les API nécessaires, avec les liens vers le Portail Développeur Transatel et les références API.
Merci de consulter d’abord cet article pour en savoir plus sur nos API.

Transatel propose de nombreuses API, mais vous pouvez commencer facilement avec seulement quelques‑unes.

Authentification API

Les API Transatel utilisent l’authentification OAuth 2.0.

Utiliser les API Authentication pour obtenir des tokens

OCS APIs (subscription, catalog, inventory)

Ce sont les API principales nécessaires au service.
Elles vous permettront d’ajouter les bons bundles à vos SIM, de récupérer le catalogue et de vérifier l’inventaire.

– OCS Subscription
Cette API vous permettra d’ajouter les bons bundles à vos SIM.

Note importante : vous pouvez utiliser deux types d’OrderType : « preload » et « subscribe ».

Les cartes SIM et eSIM Service Provider Connect vous sont livrées en statut Preactivated. Elles s’activeront automatiquement à la première connexion réseau. (Le cycle de vie des SIM Service Provider Connect est détaillé ici.)

Selon le statut de la SIM, voici l’OrderType recommandé :

• Utilisez l’OrderType « Preload » sur les SIM en statut Preactivated → la SIM restera préactivée jusqu’à son installation et utilisation par l’utilisateur final.
• Utilisez l’OrderType « Subscribe » sur les SIM en statut Active → vous ne pouvez pas précharger un plan sur une SIM déjà active.

Dans les deux cas, le plan de données ne démarrera que lorsque la SIM sera utilisée dans une zone couverte par ce plan.

Vous pouvez utiliser les exemples fournis dans la OCS Products API reference pour trouver des exemples de payloads.

– OCS Inventory
Cette API vous permet de vérifier l’inventaire d’une SIM et son solde restant.
Utilisez‑la pour afficher le solde restant d’un plan dans votre application ou interface.
– OCS Catalog
Cette API vous permet de récupérer tous les produits disponibles dans notre catalogue.

Astuce : pour vérifier les bundles par localisation, les zones couvertes sont incluses dans le champ tags, au format ISO‑2.

– OCS Events
Utilisez cette API pour recevoir les Webhooks liés au cycle de vie des produits (ex : expiration d’un bundle…).
Cela permet d’activer des notifications pour vos utilisateurs.

SIM Management

Note importante sur la gestion des SIM/eSIM dans l’offre Service Provider Connect

Notre service vous fournit votre propre stock de profils eSIM à gérer.

Nous ne fournissons pas d’API pour obtenir des profils à la demande : vous devez maintenir votre propre base de données et gérer votre stock.

Vous pouvez mettre à jour votre stock en :

• important le Subscription report quotidien disponible sur votre compte SFTP.
• important le SIM delivery file fourni à chaque commande,

Statut SIM et statut eSIM

Il existe deux cycles de vie distincts à suivre pour une SIM/eSIM :

• Le statut SIM

Cela correspond au statut télécom de la ligne.
Exemples :

• une ligne doit être active pour fonctionner,
• elle peut être suspendue pour bloquer le trafic.

Si un client ne souhaite plus utiliser le service, vous pouvez résilier la ligne.

Dans Service Provider Connect, les SIM sont livrées preactivaté : aucune action n’est requise pour les activer.

• Le status eSIM

Ce statut concerne uniquement les profils eSIM et reflète leur état sur l’appareil.

Exemples : downloaded, installed, enabled, deleted.

Dans Service Provider Connect, les profils eSIM sont livrés en statut released, donc aucune action n’est requise pour les préparer (hors ajout d’un bundle).

Les deux cycles de vie fonctionnent en parallèle, mais pour que la SIM fonctionne, elle doit être :

• en statut active,
• et enabled sur l’appareil.

eSIM Details API

Comme les eSIM sont prêtes à être utilisées, la seule API utile dans SPC est Get eSIM details, qui permet de récupérer :

• le code d’activation / QR code,
• le statut d’installation de l’eSIM sur l’appareil.

Connectivity Management APIs (optionnel)

Subscription Management API
Les SIM SPC étant préactivées, vous n’avez pas besoin d’intégrer les API d’activation :
l’activation se fait automatiquement à la première connexion réseau.

Vous pouvez toutefois intégrer ces API si :

• vous souhaitez suspendre ou résilier des SIM,
• vous souhaitez renseigner des champs comme Reference ou Groups pour organiser votre flotte (visibles dans le portail SIM Management).

Si vous souhaitez accéder à ces API, veuillez en faire la demande à votre account manager : elles ne sont pas ouvertes par défaut pour les clients SPC.

Glossaire spécifique Service Provider Connect

Comme notre documentation API est générique, voici les champs spécifiques liés à l’offre SPC

mvnoRef : nom de votre compte SPC, commençant par « M2MA_WW_TSL_….. »
Retrouvable dans la plateforme SIM Management.

COS : correspond au catalogue de l’offre.
Valeur pour les comptes production : WW_M2MA_COS_SPC

Payment : la valeur à indiquer dans les requêtes de souscription pour SPC est « Customer » (c’est vous qui payez les bundles à Transatel).

RatePlan : requis uniquement si vous utilisez l’API optionnelle Subscription Management.
Retrouvable dans Catalogue > Options dans la plateforme SIM Management.