API de projet en option
L’API est une option de l’offre applicative. Elle expose des opérations métier convenues à d’autres systèmes. Ce guide explique les commandes du projet ; il ne constitue ni une référence d’endpoints ni une activation.
Avant de commencer — Vérifiez la disponibilité dans l’offre réelle et identifiez les opérations nécessaires à un autre système. Cet article explique le parcours optionnel du projet ; les endpoints utilisables sont décrits dans sa référence API publiée.
Vérifier si le projet possède une API
Vérifiez l’offre avant de supposer que le projet possède une API active.
- Ouvrez Votre offre.
- Repérez Option API.
- Vérifiez si elle est Activée ou Non activée pour le projet.
- Lisez le prix et les conditions avant de cliquer sur Activer l'option API.
Une application peut fonctionner sans cette option. Une connexion externe déclarée n’active pas automatiquement votre propre API.
Suivre la préparation d’un projet éligible
Suivez le périmètre et les prérequis avant de considérer le catalogue comme utilisable pour une intégration.
- Ouvrez API une fois l’option activée pour le projet.
- Cliquez sur Lancer la construction de l’API. Le bouton est disponible une fois l’infrastructure API installée et au moins un module entièrement construit.
- Suivez Modules à exposer et l’état de chaque module, et utilisez Répondre si des précisions sont demandées.
- Suivez les états d’installation et de construction présentés.
Si la préparation est incomplète, suivez le prérequis indiqué. L’état de l’option et la disponibilité d’endpoints terminés sont distincts.
Vérifier les routes en ligne
Une méthode et un chemin décrivent une opération ; son état en ligne indique sa disponibilité.
- Ouvrez le catalogue des routes pour un projet activé.
- Lisez Méthode, Chemin et Description.
- Vérifiez Statut pour chaque route.
- Distinguez Prévue et En ligne.
Une route prévue décrit le périmètre envisagé ; elle ne prouve pas qu’un endpoint répond déjà.
Retrouver les bonnes informations d’intégration
Identifiez le sens de l’intégration pour utiliser les informations du service à appeler.
- Déterminez si vous exposez votre application ou utilisez le service d’un fournisseur.
- Utilisez les outils API pour exposer vos opérations.
- Consultez Connexions externes pour la documentation et les accès d’un autre fournisseur.
- Consultez la référence API du projet uniquement lorsque son API réelle est publiée.
Les bonnes informations du fournisseur ou la référence active du projet sont identifiées.
Remarque — Ne déduisez pas une URL ou un exemple d’authentification d’une route prévue. Utilisez la référence en ligne du projet et de l’environnement concernés.
Utiliser le service d’un fournisseur correspond à une connexion externe. Permettre à une autre application d’appeler vos opérations convenues utilise l’API optionnelle du projet. Ces besoins peuvent coexister, mais déclarer le premier ne crée pas et n’active pas le second.