Sommaire
Comment intégrer nos API ?
Nos API vous permettent de gérer vos SIM depuis vos propres outils : les activer, modifier leurs services, suivre leur consommation et automatiser vos processus. Cet article présente les bases à connaître avant de démarrer toute intégration, quelle que soit votre offre.
Où trouver la documentation API
Toutes les ressources API sont disponibles sur le Portail Développeurs Transatel. Vous y trouverez :
- des guides d’intégration, qui expliquent comment combiner nos API pour les cas d’usage courants ;
- la référence API, avec les endpoints, les paramètres et des exemples de requêtes.
Pour les étapes propres à votre offre, consultez l’article d’intégration dédié dans cette rubrique.
Comment obtenir vos identifiants API
Vos identifiants API sont créés en même temps que votre compte si vous en avez fait la demande. Sinon, contactez votre account manager ou votre service manager.
⚠️ Les identifiants API ne sont pas les mêmes que votre utilisateur de la plateforme de gestion des SIM (Auriga). Vous ne pouvez pas utiliser votre identifiant d’interface pour appeler nos API.
Deux façons de configurer les services de vos SIM par API
Lorsque vous activez une SIM ou modifiez ses services, vous pouvez la configurer de deux façons.
1. Avec un profil de service (recommandé)
Un profil de service est un ensemble de services prédéfini (modèle tarifaire, data, SMS, options…) créé dans la plateforme de gestion des SIM. Il fonctionne comme dans l’interface : vous indiquez la référence du profil de service dans votre appel API, et la SIM reçoit tous les services de ce profil.
Pourquoi c’est l’approche recommandée :
- Plus simple : une seule valeur à indiquer au lieu d’une liste d’options.
- Cohérente : les SIM activées par API reçoivent le même profil que les SIM activées depuis l’interface. Pour modifier leurs services, il suffit de leur attribuer un autre profil : elles ne sont pas marquées comme déviées.
- Plus facile à gérer : les SIM sont classées par profil de service dans la plateforme de gestion des SIM. Vous pouvez donc les filtrer, les vérifier et les mettre à jour par groupe.
2. Avec un rate plan et des options (avancé)
Vous indiquez le rate plan et le libellé technique de chaque option à activer. Cette méthode vous donne un contrôle total sur chaque service, SIM par SIM, mais :
- vous devez tenir à jour la liste des options dans votre intégration ;
- modifier les options d’une SIM une par une la marque comme déviée par rapport à son profil de service dans l’interface.
| Profil de service | Rate plan + options | |
|---|---|---|
| Ce que vous indiquez | Une référence de profil de service | Le rate plan + un libellé technique par option |
| Cohérence avec les SIM activées depuis l’interface | Même profil, SIM non déviée | SIM marquée comme déviée |
| Classement dans la plateforme de gestion des SIM | Par profil de service | Non regroupées par profil |
| Recommandé pour | La plupart des intégrations | Des configurations très spécifiques, SIM par SIM |
Comment trouver les valeurs à utiliser dans vos appels API
- Profils de service : dans la plateforme de gestion des SIM, allez dans Catalogue > Profils de service et utilisez la référence du profil qui y figure.
- Rate plans et options : allez dans Catalogue > Options. Ce menu liste les libellés techniques exacts à indiquer dans vos appels API pour chaque option. Si votre compte dispose de plusieurs rate plans, sélectionnez-en un dans la liste déroulante.
Besoin d’aide ?
Contactez notre équipe support via le Service Desk.