Les API sont conformes aux normes internes et externes

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.

Pourquoi cette station existe ?

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.

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.

Signaux de départ (Critères d’entrée)

Les modèles d’architecture et de plateforme API choisis ont été validés avec les parties prenantes d’architecture, de sécurité et de plateforme pertinentes.
La conception de l’API et ses capacités exposées reflètent clairement la valeur commerciale et les besoins des utilisateurs.
L’API et ses capacités exposées sont décrites de manière suffisante pour être examinées, auditées et intégrées.
La conception de l’API suit nos conventions partagées pour le produit API et la conception.
Le contrat d’API est testé et répond aux exigences fonctionnelles et non fonctionnelles.

Bien fait quand (Critères de sortie)

L’API passe avec succès les contrôles de conformité, de sécurité et d’audit.
Les résultats de l’audit et les décisions de correction sont partagés avec les parties prenantes pertinentes.
L’API est prête à être déployée et exposée via les passerelles et environnements prévus.
La documentation API destinée aux utilisateurs est suffisamment complète pour la publication et l’intégration.

Comment cela fonctionne-t-il ?

Étape

Étape1/3

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.

Mener des audits pour s'assurer que les API respectent les normes organisationnelles, techniques et juridiques avant d'être publiées.

Checklist

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

Voir l'exemple