Description API ouverte
Intégrez facilement les systèmes d'entreprise à Efecte à l'aide d'une API d'intégration moderne
Description API ouverte
Intégrez facilement les systèmes d'entreprise à Efecte à l'aide d'une API d'intégration moderne
Introduction
L'outil Efecte Service Management (ESM) intègre une API ouverte lui permettant de se connecter à tout système externe. Cette connexion est rendue possible grâce à une REST API , qui facilite l'intégration moderne avec diverses applications externes. Basée sur les principes REST , cette API offre un moyen polyvalent et efficace de gérer les données au sein de la plateforme.
L' REST API Efecte est dotée de fonctionnalités complètes visant à aider les développeurs, à rendre les intégrations plus fluides et à améliorer la façon dont différents systèmes fonctionnent ensemble.
Les organisations, quelle que soit leur taille, fonctionnent avec de nombreux systèmes et processus interconnectés. Ces systèmes peuvent être propres à un seul service ou concerner plusieurs services. En intégrant ces systèmes essentiels, les organisations peuvent réduire considérablement le travail manuel. L' REST API Efecte facilite cette démarche en offrant une interface sécurisée et intuitive aux développeurs.
Pour activer l' REST API dans un environnement Efecte, assurez-vous que l'outil de gestion des services Efecte (ESM) est mis à jour vers la version 2021.4 ou ultérieure. L'activation nécessite l'obtention d'une licence REST API auprès d'Efecte, ce qui active le module API externe Efecte de votre système. De plus, la configuration d'un utilisateur technique (local) et la définition de son rôle sont des étapes nécessaires à la gestion des accès.
Il est important de noter que l' REST API ne couvre pas les fonctions administratives ni la gestion des modèles de données au sein du système Efecte. Pour une présentation détaillée de l' REST API , veuillez consulter notre documentation REST API Efecte.
Scénarios recommandés
L' REST API est utile dans de nombreuses situations où vous devez envoyer ou recevoir des données à ESM. C'est le choix privilégié des clients et partenaires d'Efecte pour établir des connexions avec ESM. Ses utilisations courantes incluent l'importation d'informations sur les actifs et les configurations provenant d'outils d'inventaire, la connexion à d'autres plateformes ITSM ou de gestion des tickets, la liaison avec des systèmes ERP, la synchronisation avec des systèmes RH et la connexion à des outils de reporting et d'analyse.
Documentation
La documentation REST API peut être trouvée via les liens ci-dessous.
En plus de la documentation standard fournie, Efecte propose également une documentation en ligne accessible via Swagger , un outil pratique pour interagir avec l' API et consulter une documentation détaillée. Cette ressource en ligne est facilement accessible dans tout environnement disposant d'une licence REST - API valide. Vous pouvez accéder à l'interface utilisateur Swagger en accédant à votre URL de base suivie de /rest-api/itsm/v1/docs/swagger/index.html (par exemple, https://efectecloud.com/rest-api/itsm/v1/docs/swagger/index.html ).
Swagger a créé cette documentation conformément à la spécification Open API 3.0. De plus, cette documentation est téléchargeable depuis l'interface utilisateur à l'adresse URL de base, suivie de /rest-api/itsm/v1/docs/openapi.json . Après téléchargement, elle peut être importée dans divers outils d'intégration et de test, tels que Postman, pour une exploration et des tests API plus efficaces.
