API de projet en option
Exposez les opérations utiles lorsque le projet en a besoin
Examinez le périmètre API d’un projet éligible et distinguez les routes prévues des endpoints déjà construits.
Une option de projet au périmètre défini
- Examiner l’option
Vérifiez sa disponibilité et l’offre du projet.
- Définir les opérations
Précisez les actions métier que l’API doit exposer.
- Consulter les routes
Retrouvez méthode, adresse et état prévu ou en ligne de chaque route.
Ajoutez une API lorsque le projet en a besoin
L’API est une partie optionnelle de l’offre. Vérifiez son périmètre et ses conditions avant activation, sans supposer qu’elle accompagne chaque application.
Les outils organisent les routes proposées par domaine métier. Les précisions définissent le rôle des opérations avant leur construction.
Distinguez routes prévues et endpoints utilisables
Préparer l’accès d’un autre système. Un projet peut nécessiter l’utilisation de ses opérations par une autre application. Examinez le périmètre et l’offre API sans supposer que toutes les fonctions sont exposées automatiquement. Les opérations convenues définissent l’accès attendu.
Consulter le catalogue de routes. Méthode, adresse, description et état distinguent le périmètre envisagé des endpoints enregistrés en ligne. Le catalogue sert de repère pendant la préparation.
Choisir le sens de l’intégration. Utiliser l’API d’un fournisseur et exposer votre application répondent à des besoins différents. Les connexions externes couvrent le premier ; l’option API couvre l’exposition convenue. Choisissez selon l’échange recherché.
Distinguez une API exposée et une connexion externe
L’API du projet expose les opérations convenues de votre application. Une connexion externe décrit l’utilisation d’un autre service ; ces deux fonctions répondent à des besoins différents.
Le catalogue indique méthode, adresse et état prévu ou en ligne. Cette présentation n’active aucune API pour votre projet.
Évaluez l’option API à partir d’un besoin concret
Identifiez qui doit utiliser les données du projet et quelles opérations sont nécessaires. Cela aide à distinguer un périmètre API optionnel d’une connexion à un service externe déjà existant.
Pour un projet éligible, consultez les routes prévues et leur état de construction. Vérifiez le service et l’environnement concernés avant de considérer un endpoint comme disponible pour une intégration.
Du périmètre optionnel à une exposition vérifiée
Examiner les conditions. Consultez la disponibilité et les conditions de l’option dans l’offre du projet. Déterminez les opérations qu’une application externe doit utiliser avant de décider de son activation.
Préciser les opérations. Examinez les opérations proposées et répondez aux questions de préparation. Suivez les prérequis et la construction pour distinguer le périmètre prévu de ce qui est effectivement réalisé.
Consulter ce qui est en ligne. Vérifiez le catalogue et la référence du projet dont l’API est activée. Une route envisagée ne suffit pas à commencer une intégration : contrôlez les opérations et les informations réellement disponibles.
Définissez l’échange avant d’ajouter une API
Expliquez les opérations utiles à l’autre système et examinez les conditions. L’API doit soutenir un échange métier convenu.
Questions fréquentes
C’est une option dont disponibilité et prix figurent dans l’offre réelle. L’application peut fonctionner sans activation. Cette présentation ne crée ni n’active une API pour votre projet.
Elle décrit une opération envisagée, pas encore enregistrée en ligne. Consultez état du catalogue et référence publiée avant une intégration.
Les vues présentent domaines à exposer, questions, infrastructure et construction. Résolvez les prérequis puis consultez le catalogue obtenu.
Dans la référence du projet activé et de l’environnement concerné. Ne déduisez pas un endpoint ou une authentification d’une seule route prévue.
Elles décrivent le service utilisé par votre application. Ce sens d’intégration est distinct de l’exposition de vos opérations par l’API du projet.