Station

Publication d’API

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

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.

Votre parcours sur la carte

Plan de métro

Select a cycle, station, or stakeholder to open its permanent method page.

StratégiqueGouvernanceConsommateurTechniqueExpérience utilisateurExpérience utilisateurAperçus du marchéAperçus du marchéObjectifs de l'entrepriseObjectifs de l'entrepriseAnalyse concurrentielleAnalyse concurrentielleVision de l'écosystèmeVision de l'écosystèmeInfrastructure évolutiveInfrastructure évolutiveJuridique et conformitéJuridique et conformitéSécurité et confidentialitéSécurité et confidentialitéNormes de conceptionNormes de conceptionGestion des fournisseursGestion des fournisseursConception des contratsConception des contratsDéveloppementDéveloppementCI/CDCI/CDAutomatisation des testsAutomatisation des testsGestion des versionsGestion des versionsAccords de serviceAccords de serviceAdoption de l'API par les utilisateursAdoption de l'API par les utilisateursPromotion de l'APIPromotion de l'APIIntégration des partenairesIntégration des partenairesL'état d'esprit de l'APIL'état d'esprit de l'APIRôles et responsabilitésRôles et responsabilitésUpkillingUpkillingLignes directrices opérationnellesLignes directrices opérationnellesGestion de portefeuilleGestion de portefeuilleGestion du budget et des ressourcesGestion du budget et des ressourcesStratégie de capacité1Stratégie produit APIExigences utilisateurs & onboarding2Expérience utilisateurAPIArchitecture & décisions de plateforme3Architecture deplateforme APIConception de solution & d'interface4Conception d’APIMise à disposition & opérations5Livraison d’APIAssurance qualité & préparation6Audit APIPublication & enablement7Publication d’APISuivi & amélioration8Suivi & amelioration APILigne des opportunités métierLigne d'architecture de la plateformeLigne de conception de l'APILigne de livraisonLigne Publication & EnablementLigne de modèle opérationnel

Selected station: Publication & enablement

Personnes à impliquer

Ressources associées

Résultats

  • API publiées dans le bon environnement (privé, partenaire, public)
  • Des processus clairs d'intégration et d'enregistrement de l'API
  • Documentation, modèles de sécurité et politiques disponibles
  • Des API prêtes pour l'échelle et la gouvernance

Critères du parcours

Critères d'entrée

  • L'architecture, la plateforme et le mode de mise en œuvre choisis ont été validés avec les parties prenantes concernées en architecture, sécurité et plateforme.
  • La conception de l'interface et les capacités exposées sont clairement reliées à la valeur métier et aux besoins des utilisateurs.
  • L’interface et ses capacités sont documentées de manière suffisamment claire pour la revue, l’audit et l’onboarding.
  • La conception de l'interface respecte les standards partagés de produit, de conception et de qualité.
  • Le contrat d'interface a été validé et testé par rapport aux exigences fonctionnelles et non fonctionnelles.

Critères de sortie

  • La solution réussit les contrôles de qualité, de sécurité, de conformité et de préparation.
  • Les résultats d'audit et les décisions de correction sont partagés avec les parties prenantes concernées.
  • La capacité est prête à être publiée ou mise à disposition via le mécanisme de livraison choisi.
  • La documentation et les supports d'onboarding destinés aux utilisateurs sont prêts.

Voici à quoi ressemble le succès

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 utilisateurs et des exigences en matière de sécurité et de conformité.

  1. Publier les API dans les passerelles et les environnements appropriés afin de favoriser la réutilisation pour de multiples utilisateurs.
  2. Documenter la manière dont les utilisateurs trouvent et utilisent l'API, y compris les processus d'accueil et d'enregistrement.
  3. Veiller à ce que les modèles de sécurité, la configuration de la passerelle et les termes juridiques soient clairs et accessibles aux utilisateurs. — Liste de contrôle de l'audit de l'API

Metro lines

Ressources associées

Browse the resources selected for Publication d’API; the summary above explains how they support this station’s work.

Ressources

Resources for Publication d’API

checklist

Liste de contrôle de l'audit de l'API

Une liste de contrôle basée sur le cycle de vie permettant de vérifier l'état de préparation de l'API à travers les phases de conception, de livraison, de publication et de conformité à l'aide de critères d'audit et de preuves définis.

Résultats

  • Compréhension partagée de l’objectif et de l’utilisation de « Liste de contrôle de l'audit de l'API »
  • Approche cohérente pour appliquer « Liste de contrôle de l'audit de l'API »
  • Meilleure application des pratiques associées

Comment cela fonctionne-t-il ?

  1. Utilisez la liste de contrôle de l'audit de l'API pour vous assurer que la conception de l'API répond aux exigences fonctionnelles et non fonctionnelles, notamment en matière de sécurité, de performances et de conformité.
  2. Réalisez des audits pour évaluer la couverture du cycle de vie et vérifier que l'API respecte les normes métier, de conception et opérationnelles.
  3. S'assurer que la documentation, les modèles de sécurité, la configuration de la passerelle et les exigences légales sont clairement définis, validés et étayés par des preuves.

Relevant cycles

Cycle d’automatisation

Cycle pour identifier, concevoir, livrer, enable et améliorer des opportunités d’automatisation.