L’API SOAP (Simple Object Access Protocol) est un protocole basé sur le langage XML dont le format est très structuré.
Il se compose de trois parties :
une enveloppe, qui définit la structure du message et la manière de le traiter
un ensemble de règles de codage pour exprimer des instances de types de données définis par l’application
une convention pour représenter les appels de procédure et les réponses
Avec ce format d’API, toutes les méthodes et propriétés sont décrites par un document XML, le Web Services Description Language (WSDL).
L’API SOAP a évolué comme un successeur de XML-RPC où vous utilisez des méthodes à distance dans des scripts de quelques lignes seulement. Cependant, l’implémentation du protocole est un peu complexe et vous devrez utiliser les librairies SOAP existantes dans votre langage préféré.
Grâce à cette API, vous pouvez acheter et configurer les produits Netim sans avoir besoin de vous connecter à l’interface web.
Comment accéder à l'API ?
Pour utiliser l’API SOAP, vous devez disposer d’un compte revendeur.
Si vous êtes un client existant, contactez l’équipe commerciale afin d’en savoir plus sur le programme pour revendeurs et de mettre votre compte à niveau.
Il est recommandé d’utiliser l’environnement de test opérationnel (OTE) pour intégrer l’API. Notre OTE est une réplique exacte de nos systèmes à des fins de développement.
Avec quels langages est compatible l'API?
Tout langage de programmation prenant en charge le protocole SOAP peut être utilisé.
Cette API est principalement utilisée au quotidien avec PHP qui est facilement pris en charge :
D’autres langages peuvent être utilisés, mais nous ne garantissons pas que le WSDL sera entièrement supporté. L’API SOAP est un peu ancienne et, de nos jours, certains clients rencontrent des problèmes lors de la génération des classes à partir du WSDL. Dans ce cas, nous encourageons l’utilisation de l’API REST.