Publication d'API

Exposer les API de manière sûre et claire au bon public avec la bonne documentation et les bons processus.

Résultats

• API publiées dans le bon environnement (privé, partenaire, public)

Lignes de métro associées

• Ligne d’édition et d’adoption

Pourquoi c’est important

La publication va plus loin que le déploiement - il s’agit de la découvrabilité, de l’accès et de l’assistance. Si les API ne sont pas publiées correctement, elles ne seront pas utilisées, réutilisées ou sécurisées efficacement.

Critères d’entrée

• L’API passe avec succès les contrôles de conformité, de sécurité et d’audit.
• Les rapports d’audit sont partagés avec les parties prenantes.
• L’API est prête à être publiée sur les passerelles et dans les environnements appropriés afin de permettre sa réutilisation par plusieurs consommateurs d’API.
• La documentation de l’API est complète et prête à être publiée.

Critères de sortie

• La documentation de l’API est complète et prête à être publiée.
• Les processus d’enregistrement, d’assistance et de communication relatifs à l’API sont en place.
• Les exigences légales et de conformité sont suffisamment précises pour permettre la publication.

Comment cela fonctionne-t-il ?

1. Publier les API dans les passerelles et les environnements appropriés afin de favoriser la réutilisation pour de multiples consommateurs d’API.
2. Documenter la manière dont les consommateurs trouvent et utilisent l’API, y compris les processus d’accueil et d’enregistrement.
   Meilleures pratiques en matière d'intégration de l'API Meilleures pratiques pour rationaliser les parcours d'accueil des consommateurs d'API avec une inscription étape par étape, une découverte et des conseils pour le premier appel.
3. Veiller à ce que les modèles de sécurité, la configuration de la passerelle et les termes juridiques soient clairs et accessibles aux consommateurs.
   Liste de contrôle de l'audit de l'API Une liste de contrôle complète pour vérifier l'état de préparation de l'API avant sa publication, couvrant la conception, la documentation, la sécurité et la conformité aux politiques.

Appliquer dans votre travail

Permettre aux API d’être publiées dans l’environnement approprié et disposer de mécanismes d’enregistrement et d’accès clairs (par exemple, clés API, OAuth, plans d’abonnement) en fonction des segments de consommateurs d’API et des exigences en matière de sécurité et de conformité.