Station

Audit API

Vérifiez que les API répondent aux normes métier, de conception et opérationnelles avant leur publication et leur mise à disposition.

Les API sont des produits à longue durée de vie et doivent répondre aux attentes en matière de qualité, de cohérence et de conformité. L'audit relie les décisions de conception, la mise en œuvre et l'état de préparation opérationnelle à des normes définies, réduisant ainsi les risques avant la mise à disposition.

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: Assurance qualité & préparation

Personnes à impliquer

Ressources associées

Résultats

  • Les API sont conformes aux normes internes et externes
  • Documentation claire des décisions relatives à la conception et à la mise en œuvre de l'API
  • Sécurité, performance et conformité validées
  • Réduction du risque de problèmes en production

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.
  • L’interface choisie fournit une abstraction appropriée aux utilisateurs.
  • La conception de l'interface et les capacités exposées sont clairement reliées à la valeur métier et aux besoins des utilisateurs.
  • La conception de l'interface respecte les standards partagés de produit, de conception et de qualité.

Critères de sortie

  • 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.

Voici à quoi ressemble le succès

Mettez en place un processus d'audit cohérent qui évalue l'état de préparation des API à toutes les étapes du cycle de vie à l'aide de critères, de preuves et de normes définis. Assurez-vous que les lacunes sont identifiées tôt et résolues avant la publication.

  1. Mener des audits pour s'assurer que les API respectent les normes organisationnelles, techniques et juridiques avant d'être publiées. — Liste de contrôle de l'audit de l'API
  2. Utiliser des listes de contrôle, des linters et des outils de test pour vérifier la cohérence et la conformité avec les normes.
  3. Collaborer avec les équipes de gouvernance et les experts du domaine pour s'assurer que les API sont prêtes pour la production.

Metro lines

Ligne de conception de l'API

Se concentre sur les principes et les bonnes pratiques de conception des interfaces et des solutions d'intégration.

Ressources associées

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

Ressources

Resources for Audit 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.