Cycle de productisation des capacités d’intégration
Cycle pour productiser des capacites d integration reutilisables avant de choisir le mode de mise en oeuvre.
Guider la conception de capacites d integration reutilisables avant de choisir un mode de mise en oeuvre API, evenement, fichier, flux, produit de donnees, integration directe ou hybride.
Votre parcours sur la carte
Plan de métro
Select a cycle, station, or stakeholder to open its permanent method page.
Selected station: Stratégie de capacité
Personnes à impliquer
Resources and canvases
Critères du parcours
Critères d'entrée
Les objectifs métier sont définis.
L'opportunité de capacité est identifiée et documentée.
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.
L’interface et ses capacités sont documentées de manière suffisamment claire pour la revue, l’audit et l’onboarding.
La solution réussit les contrôles de qualité, de sécurité, de conformité et de préparation.
Cadrer la capacite d integration reutilisable, le besoin metier, la responsabilite et la reutilisation attendue avant de choisir le mode de mise en oeuvre.
Les initiatives d'intégration et d'API passent souvent trop vite à un choix technique. Cette station maintient l'équipe concentrée sur le parcours métier, le domaine, la valeur, le potentiel de réutilisation, la responsabilité et la faisabilité avant de choisir API, événements, fichiers, flux, produits de données ou intégration directe.
Capturez les utilisateurs d’intégration, les responsabilités des fournisseurs, les besoins d’onboarding, les attentes de service et les contraintes opérationnelles.
La bonne architecture dépend des objectifs des utilisateurs, des attentes d'onboarding, des niveaux de service, de la qualité des données, de la tolérance au changement, de l'observabilité, du support et des contraintes du fournisseur.
Choisir l architecture d integration, le mode de mise en oeuvre et les capacites de plateforme en tenant compte des contraintes et du modele de gouvernance.
Une capacité réutilisable nécessite des décisions d'architecture alignées sur les exigences utilisateurs, la sécurité, les flux de données, le modèle opérationnel et la réalité des plateformes existantes.
Concevoir le contrat d interface, les schemas, les payloads et les modeles d interaction pour le style d integration choisi.
Une bonne conception va au-delà du nommage des endpoints. Elle garantit que l'interface est utilisable, cohérente, vérifiable et traçable aux besoins métier et utilisateurs.
Construire, tester, automatiser, deployer et exploiter la capacite d integration avec le mode de mise en oeuvre choisi et le contrat d interface valide.
Une capacité réutilisable a besoin d'une mise à disposition et d'un fonctionnement fiables, qu'elle soit réalisée sous forme d'API, de flux d'événements, d'échange de fichiers, de produit de données ou d'intégration directe.
Assurez la préparation, la gouvernance, la qualité, la sécurité, la conformité et les preuves opérationnelles de l’intégration avant publication.
Les capacités réutilisables créent des risques opérationnels, liés aux données, à la sécurité, à la confidentialité, à la conformité et à l'expérience utilisateur. Les revues de préparation réduisent les surprises avant la publication ou l'utilisation en production.
Publier la capacite d integration afin que les equipes puissent la decouvrir, l evaluer, demander l acces, terminer l onboarding, la reutiliser et obtenir du support.
Une capacité réutilisable ne crée de la valeur que si les utilisateurs peuvent la trouver, comprendre le contrat d'interface et les attentes de service, demander l'accès et connaître le support ainsi que la responsabilité du cycle de vie.
Suivez la fiabilité, la réutilisation, les incidents, la performance, les résultats utilisateurs et les besoins d’amélioration de l’intégration.
Les capacités ont besoin de retours continus pour rester fiables, utiles, économiquement pertinentes et réutilisables lorsque les utilisateurs, systèmes, données et plateformes évoluent.
Publish this cycle
Export the page-specific template after reviewing the entity summary and supporting details above.
Export Confluence
Modèles de publication
Use Markdown for repositories and static sites, or Confluence-wiki markup for compatible Confluence pages.
Markdown
# Cycle de productisation des capacités d’intégration question template
Cycle pour productiser des capacites d integration reutilisables avant de choisir le mode de mise en oeuvre.
Use this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.
## 1. Stratégie de capacité d’intégration
Cadrer la capacite d integration reutilisable, le besoin metier, la responsabilite et la reutilisation attendue avant de choisir le mode de mise en oeuvre.
### Canvas questions
#### Customer Journey Canvas
Quel parcours client ou partenaire crée le besoin de capacité ou d’interface ?
- **Persona**: Qui est le client type qui vit ce parcours?
- **Le client découvre le besoin**: Comment le client reconnaît-il son besoin ou son problème?
- **Le besoin du client est résolu**: Comment le besoin du client est-il finalement résolu?
- **Étapes du parcours**: Quelles sont les étapes suivies par le client dans son parcours?
- **Douleurs**: Quels sont les irritants ou défis du client?
- **Gains**: Quels sont les gains ou bénéfices pour le client?
- **Entrées et sorties**: Quelles sont les entrées et les sorties à chaque étape?
- **Règles d'interaction et de traitement**: Quelles sont les règles d'interaction et de traitement à chaque étape?
#### Domain Canvas
Quels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?
- **Étapes du parcours client sélectionnées**: Quelles étapes du parcours client sont pertinentes pour ce domaine?
- **Entités principales et signification métier**: Quelles sont les entités principales et leur signification métier?
- **Attributs et importance métier**: Quels sont les attributs clés de chaque entité et leur importance métier?
- **Relations entre les entités**: Quelles sont les relations entre les entités?
- **Règles métier, conformité et intégrité**: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?
- **Considérations de sécurité et de confidentialité**: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?
#### Capability Value Proposition Canvas
Quelle capacité réutilisable créerait de la valeur pour les utilisateurs sans décider encore si elle doit être mise à disposition sous forme d’API, d’événement, de fichier, de flux, de produit de données ou d’un autre mode de mise en œuvre ?
- **Tâches et résultats des utilisateurs**: Que cherchent à accomplir les utilisateurs, partenaires, systèmes ou équipes ?
- **Fonctionnalités de capacité génératrices de gains**: Quelles fonctionnalités de capacité aideraient les utilisateurs à obtenir de meilleurs résultats, plus de rapidité, d’automatisation, d’insights, de portée ou de conformité ?
- **Fonctionnalités de capacité qui réduisent les irritants**: Quelles fonctionnalités de capacité supprimeraient les frictions, le travail manuel, les erreurs, les retards, les risques ou l’incertitude pour les utilisateurs ?
- **Capacités réutilisables**: Quelles capacités métier ou données réutilisables pourraient répondre à ces tâches, gains et irritants pour plusieurs utilisateurs ou cas d’usage ?
#### Capability Business Model Canvas
Dans quelle mesure cette capacité d’intégration doit-elle être viable, réutilisable, financée, possédée, accompagnée et découvrable ?
- **Proposition de valeur de la capacité**: Quelle valeur cette capacité réutilisable apporte-t-elle aux utilisateurs et à l’organisation ou à l’écosystème ?
- **Segments d’utilisateurs de la capacité**: Qui sont les utilisateurs actuels et potentiels de la capacité, y compris équipes, partenaires, systèmes, produits ou utilisateurs de données ?
- **Engagement des utilisateurs**: Comment les utilisateurs découvriront-ils, évalueront-ils, demanderont-ils, onboarderont-ils, obtiendront-ils du support et donneront-ils du feedback sur la capacité ?
- **Canaux**: Par quels catalogues, portails, marketplaces, sites de documentation, parcours de support ou processus de gouvernance les utilisateurs interagiront-ils avec la capacité ?
- **Ressources clés**: Quels systèmes, actifs de données, plateformes, personnes, standards, financements et capacités opérationnelles sont nécessaires ?
- **Activités clés**: Que doivent faire le responsable de la capacité et les producteurs pour concevoir, mettre à disposition, gouverner, accompagner et améliorer la capacité ?
- **Partenaires clés**: Quels partenaires métier, technologie, données, sécurité, juridique, plateforme ou externes sont nécessaires pour faire fonctionner la capacité ?
- **Bénéfices**: Quels bénéfices métier, opérationnels, écosystémiques, de réutilisation, de conformité ou de coût justifient la capacité ?
- **Coûts**: Quels sont les coûts significatifs de construction, d’exploitation, de gouvernance, de support et d’évolution de la capacité ?
## 2. Exigences des utilisateurs d’intégration & onboarding
Capturez les utilisateurs d’intégration, les responsabilités des fournisseurs, les besoins d’onboarding, les attentes de service et les contraintes opérationnelles.
### Canvas questions
#### Consumer Experience Requirements Canvas
Quelles exigences d’expérience et non fonctionnelles les utilisateurs doivent-ils préciser avant de décider de la meilleure architecture d’intégration ?
- **Objectifs des utilisateurs**: Quels sont les objectifs métier, de workflow, de décision, d’automatisation ou d’usage des données des utilisateurs ?
- **Disponibilité et fraîcheur**: Quand la capacité doit-elle être disponible, quelle fraîcheur d’information est nécessaire et quelles fenêtres de latence ou de mise à disposition comptent ?
- **Volume et performance**: Quels volumes de requêtes, événements, enregistrements, fichiers, lots, utilisateurs ou transactions la capacité doit-elle supporter aujourd’hui et demain ?
- **Qualité et cohérence des données**: Quelles attentes les utilisateurs ont-ils en matière d’exactitude, complétude, cohérence, ordre, déduplication, rapprochement ou validation ?
- **Sécurité, protection des données et conformité**: Quelles contraintes d’identité, d’autorisation, de confidentialité, de résidence, de consentement, de conservation, d’audit ou de réglementation s’appliquent ?
- **Onboarding et accès**: Comment les utilisateurs doivent-ils trouver, demander, tester, obtenir l’approbation et commencer à utiliser la capacité ?
- **Changement et versionnement**: Quelle tolérance au changement les utilisateurs ont-ils, et quelles attentes de préavis, compatibilité, migration ou versionnement s’appliquent ?
- **Observabilité et support**: De quelle surveillance, information de statut, traçabilité, visibilité sur la qualité des données, support, propriété et communication d’incident les utilisateurs ont-ils besoin ?
- **Reprise et continuité**: Quelles attentes de replay, retry, rapprochement, sauvegarde, fallback, continuité ou reprise manuelle doivent être prises en charge ?
- **Implications d’architecture**: Que signifient ces exigences pour les styles d’architecture possibles, tels que API, événements, fichiers, flux, produits de données ou intégration directe ?
### Other related resources
- **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. Architecture d integration & decisions de plateforme
Choisir l architecture d integration, le mode de mise en oeuvre et les capacites de plateforme en tenant compte des contraintes et du modele de gouvernance.
### Canvas questions
#### Business Impact Canvas
Quels impacts métier une défaillance ou un mauvais comportement de la capacité ou de l’interface peut-il avoir ?
- **Risques de disponibilité**: Quels sont les risques potentiels pour la disponibilité de l’API?
- **Atténuer les risques de disponibilité**: Comment le fournisseur d’API peut-il atténuer les risques de disponibilité?
- **Risques de sécurité**: Quels sont les risques de sécurité potentiels associés à l’API?
- **Atténuer les risques de sécurité**: Comment le fournisseur d’API peut-il atténuer les risques de sécurité?
- **Risques liés aux données**: Quels sont les risques potententiels pour l'intégrité ou la protection des données?
- **Atténuer les risques liés aux données**: Comment le fournisseur d’API peut-il atténuer les risques liés aux données?
#### Location Canvas
Quelles frontières géopolitiques, réglementaires, réseau et de confiance affectent cette capacité ou interface ?
- **Groupes de localisation / de confiance**: Quels sont les groupes géopolitiques, réglementaires, de réseau ou de confiance pertinents ?
- **Caractéristiques des groupes**: uelles sont les caractéristiques de ces groupes, telles que la localisation, le niveau de confiance ou l'exposition réseau ?
- **Emplacements / Zones pertinents**: Quels sont les emplacements, zones ou environnements pertinents au sein de chaque groupe ?
- **Caractéristiques des emplacements / zones**: Quelles sont les caractéristiques de ces emplacements ou zones, telles que la propriété, la région ou l'exposition ?
- **Distances réseau / réglementaires**: Quelles sont les distances en termes de latence, de confiance, de réglementation ou de connectivité entre les emplacements ?
- **Caractéristiques des distance**: Quelles sont les caractéristiques de ces distances, telles que la sensibilité à la latence, les contraintes de résidence ou les limites de confiance ?
- **Points de terminaison de connectivité**: Quels sont les points de terminaison ou interfaces de connectivité associés aux emplacements ?
- **Caractéristiques d'accès aux points de terminaison**: Quelles sont les caractéristiques de ces points de terminaison, telles que l'exposition, le protocole, la sécurité ou les restrictions d'accès ?
#### Capacity Canvas
Quelle capacité est nécessaire pour soutenir l’usage de la capacité ou de l’interface ?
- **Volumes d'activité actuels**: Quels sont les volumes d'affaires et taux de transaction actuels?
- **Tendances de consommation futures**: Quelles sont les tendances de consommation anticipées?
- **Exigences de charge maximale et de disponibilité**: Quelles sont les exigences de charge maximale et de disponibilité?
- **Stratégies de mise en cache**: Quelles stratégies de mise en cache peuvent être utilisées pour optimiser les performances?
- **Stratégies de limitation de débit**: Quelles stratégies de limitation de débit peuvent être utilisées pour gérer la consommation?
- **Stratégies de montée en charge**: Quelles stratégies d'évolutivité peuvent être utilisées pour accompagner la croissance?
### Other related resources
- **Lignes directrices pour l'intégration des partenaires**: Listes de contrôle de l'intégration et modèles de communication pour gérer les aspects techniques et juridiques des relations avec des API tierces.
## 4. Conception de solution d’intégration
Concevoir le contrat d interface, les schemas, les payloads et les modeles d interaction pour le style d integration choisi.
### Canvas questions
#### Domain Canvas
Quels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?
- **Étapes du parcours client sélectionnées**: Quelles étapes du parcours client sont pertinentes pour ce domaine?
- **Entités principales et signification métier**: Quelles sont les entités principales et leur signification métier?
- **Attributs et importance métier**: Quels sont les attributs clés de chaque entité et leur importance métier?
- **Relations entre les entités**: Quelles sont les relations entre les entités?
- **Règles métier, conformité et intégrité**: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?
- **Considérations de sécurité et de confidentialité**: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?
#### Interaction Canvas
Quels types d’interactions cette capacité ou interface doit-elle prendre en charge avant de choisir une conception propre au protocole ?
- **Interactions CRUD**: Quelles interactions CRUD (Create, Read, Update, Delete) sont-elles nécessaires ici?
- **Modèles d'entrée et de sortie CRUD**: Quels sont les modèles d'entrée et de sortie pour les interactions CRUD, si ce style est nécessaire ?
- **Traitement et validation CRUD**: QQuelles sont les règles de traitement et de validation pour les interactions CRUD, si ce style est nécessaire ?
- **Interactions pilotées par requêtes**: Quelles interactions de lecture ou de requête sont nécessaires pour répondre aux questions des utilisateurs ?
- **Modèles d'entrée et de sortie pilotés par les requêtes**: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par les requêtes ?
- **Traitement et validation pilotés par les requêtes**: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les requêtes ?
- **Interactions pilotées par commandes**: Quelles commandes modifiant l'état sont nécessaires, le cas échéant ?
- **Modèles d'entrée et de sortie pilotés par commande**: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par commande, si ce style est nécessaire ?
- **Traitement et validation pilotés par les commandes**: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les commandes, si ce style est nécessaire ?
- **Interactions pilotées par les événements**: Quels événements doivent être publiés ou consommés, le cas échéant ?
- **Modèles d'entrée et de sortie pilotés par les événements**: Modèles d'entrée et de sortie pilotés par les événements
- **Traitement et validation pilotés par les événements**: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les événements, si ce style est requis ?
#### REST Canvas
Comment concevoir l’API selon les principes RESTful ?
- **Ressources API**: Quelles sont les ressources clés exposées par l’API?
- **Modèle de ressource API**: Quelle est la structure du modèle de ressources de l’API?
- **Verbes API**: Quels verbes HTTP sont utilisés pour interagir avec les ressources de l’API?
- **Exemple de verbe API**: Fournissez un exemple de requête et de réponse API pour chaque verbe.
#### Event Canvas
Quels événements sont pertinents pour la capacité ou l’interface, et comment sont-ils traités ?
- **Tâche utilisateur / Déclencheur**: Quelle action utilisateur ou événement système déclenche cette opération d'événement?
- **Entrée / Charge utile de l'événement**: Quelles données sont incluses dans la charge utile de l'événement entrant? Spécifiez les attributs clés.
- **Traitement / Logique**: Décrivez la logique de traitement systèmes backend, y compris les validations, transformations ou décisions de routage.
- **Sortie / Résultat de l'événement**: Quel événement ou accusé de réception est produit? Incluez les attributs de la charge utile de sortie.
#### GraphQL Canvas
Comment concevoir l’API selon les principes GraphQL ?
- **Nom de l’API**: Quel est le nom de l’API GraphQL ou du point de terminaison ?
- **Objectifs des utilisateurs**: Quels problèmes les utilisateurs de l’API cherchent-ils à résoudre ? Quelles données leur sont nécessaires ?
- **Types clés**: Quels sont les types principaux exposés (ex. Utilisateur, Commande, Produit) ?
- **Relations**: Comment les types sont-ils liés dans les requêtes imbriquées ?
- **Requêtes**: Quelles requêtes courantes doivent être prises en charge ?
- **Mutations**: Quelles opérations vont modifier les données (ex. créer, mettre à jour, supprimer) ?
- **Abonnements**: Existe-t-il des mises à jour en temps réel ou des événements auxquels les utilisateurs peuvent s'abonner ?
- **Règles d'autorisation**: Qui peut accéder à quels champs ou types ?
- **Contraintes des utilisateurs**: Y a-t-il des contraintes de pagination, de filtrage ou de limitation du débit ?
- **Notes / Questions ouvertes**: Y a-t-il des décisions en attente ou des considérations d’intégration ?
### Other related resources
- **Guide de sélection du mode d’intégration**: Guide pour choisir entre API, événement, fichier, flux, produit de données, intégration directe ou mode hybride selon les exigences et contraintes.
- **Contrat de première conception**: Une ligne directrice qui préconise des approches "API-first" utilisant des contrats formels (par exemple, OpenAPI) pour aligner les parties prenantes avant le développement.
## 5. Livraison & opérations d’intégration
Construire, tester, automatiser, deployer et exploiter la capacite d integration avec le mode de mise en oeuvre choisi et le contrat d interface valide.
### Station questions
- Utilisez les pratiques de développement pour implémenter le contrat d'interface validé avec les frameworks, bibliothèques et standards d'équipe établis.
- Construisez l'implémentation de l'API à partir du contrat validé en utilisant des frameworks, des bibliothèques et des normes d'équipe établis.
- Tester les fonctionnalités, la sécurité et les performances des API à l'aide d'outils de test automatisés.
- Utiliser les pipelines CI/CD pour automatiser les processus de construction, de test et de déploiement, en garantissant une qualité et une traçabilité constantes.
- S'assurer que les API répondent aux exigences de sécurité et de conformité grâce à des contrôles et des audits automatisés.
- Utilisez la liste de contrôle de l'audit de l'API pour vous assurer que l'API répond aux exigences fonctionnelles et non fonctionnelles, notamment en matière de sécurité, de performances et de conformité.
- Appliquez les pratiques de mise en œuvre, de test, de CI/CD, d'exploitation et de sécurité au mode de mise en œuvre choisi.
- Une capacité réutilisable a besoin d'une mise à disposition et d'un fonctionnement fiables, qu'elle soit réalisée sous forme d'API, de flux d'événements, d'échange de fichiers, de produit de données ou d'intégration directe.
### Other related resources
- **Meilleures pratiques en matière de développement d'API**: Guide de mise en œuvre pour transformer un contrat d’interface API validé en une base de code API cohérente et maintenable, à l’aide de bibliothèques standard, de modèles réutilisables et de workflows de développement harmonisés.
- **Meilleures pratiques de test de l'API**: Lignes directrices pour la mise en œuvre de tests fonctionnels, de performance et de sécurité automatisés tout au long du cycle de vie de l'API.
- **APIOps CI/CD pour les API**: Des conseils de déploiement qui intègrent les tâches du cycle de vie de l'API - conception, test, gouvernance - dans les pipelines d'intégration et de livraison en continu.
- **Meilleures pratiques en matière de sécurité des API**: Un ensemble de contrôles exploitables pour sécuriser les API, y compris l'authentification, l'autorisation, le cryptage, la limitation du débit et les contrôles de conformité au niveau du pipeline.
- **Lignes directrices pour l'intégration des partenaires**: Listes de contrôle de l'intégration et modèles de communication pour gérer les aspects techniques et juridiques des relations avec des API tierces.
## 6. Assurance qualité des intégrations
Assurez la préparation, la gouvernance, la qualité, la sécurité, la conformité et les preuves opérationnelles de l’intégration avant publication.
### Station questions
- Utilisez des checklists, linters, tests et revues pour vérifier cohérence, standards, sécurité, performance et conformité.
- 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.
- Collaborer avec les équipes de gouvernance et les experts du domaine pour s'assurer que les API sont prêtes pour la production.
- Utilisez les ressources d'audit et de conformité pour vérifier que la capacité peut être publiée et réutilisée de manière contrôlée.
- Les capacités réutilisables créent des risques opérationnels, liés aux données, à la sécurité, à la confidentialité, à la conformité et à l'expérience utilisateur. Les revues de préparation réduisent les surprises avant la publication ou l'utilisation en production.
### Other related resources
- **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.
- **Meilleures pratiques en matière de conformité de l'API**: Veiller à ce que les API respectent la conformité légale, réglementaire et interne grâce à la documentation, aux contrôles et aux validations automatisées.
## 7. Publication & enablement de l integration
Publier la capacite d integration afin que les equipes puissent la decouvrir, l evaluer, demander l acces, terminer l onboarding, la reutiliser et obtenir du support.
### Station questions
- Publiez les informations de capacité dans les catalogues, portails, passerelles ou environnements appropriés afin que plusieurs utilisateurs puissent la réutiliser.
- Documenter la manière dont les utilisateurs trouvent et utilisent l'API, y compris les processus d'accueil et d'enregistrement.
- Veiller à ce que les modèles de sécurité, la configuration de la passerelle et les termes juridiques soient clairs et accessibles aux utilisateurs.
- Publiez la responsabilité, la documentation, l'onboarding, les contacts support, les attentes de service, le statut de cycle de vie et les chemins d'accès.
- Une capacité réutilisable ne crée de la valeur que si les utilisateurs peuvent la trouver, comprendre le contrat d'interface et les attentes de service, demander l'accès et connaître le support ainsi que la responsabilité du cycle de vie.
### Other related resources
- **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.
- **Modèle de contrat de service**: Un format d'accord personnalisable qui définit les attentes, les accords de niveau de service, les responsabilités et les conditions d'accès pour la consommation d'API.
## 8. Suivi & amélioration des intégrations
Suivez la fiabilité, la réutilisation, les incidents, la performance, les résultats utilisateurs et les besoins d’amélioration de l’intégration.
### Station questions
- Définissez des métriques d'utilisation, fiabilité, qualité des données, coût, adoption et valeur utilisateur.
- Analyser les indicateurs d'utilisation de l'API et intégrer les commentaires des utilisateurs dans les itérations de l'API.
- Prendre l'habitude d'examiner les mesures et de planifier des activités d'amélioration continue.
- Utilisez des métriques, analyses et pratiques de feedback pour améliorer continuellement la capacité.
- Les capacités ont besoin de retours continus pour rester fiables, utiles, économiquement pertinentes et réutilisables lorsque les utilisateurs, systèmes, données et plateformes évoluent.
### Other related resources
- **Mesures et analyses de l'API**: Une ressource pour définir, collecter et analyser les performances de l'API et les données d'utilisation afin d'aligner les KPI techniques sur les résultats de l'entreprise.
- **Stratégies d'engagement de la communauté de l'API**: Un guide pour favoriser l'adoption des API en cultivant des communautés grâce à des contenus, des canaux d'assistance, des boucles de retour d'information et des stratégies d'engagement social.
Confluence-wiki
h1. Cycle de productisation des capacités d’intégration question template
Cycle pour productiser des capacites d integration reutilisables avant de choisir le mode de mise en oeuvre.
Use this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.
h2. 1. Stratégie de capacité d’intégration
Cadrer la capacite d integration reutilisable, le besoin metier, la responsabilite et la reutilisation attendue avant de choisir le mode de mise en oeuvre.
h3. Canvas questions
#### Customer Journey Canvas
Quel parcours client ou partenaire crée le besoin de capacité ou d’interface ?
* *Persona*: Qui est le client type qui vit ce parcours?
* *Le client découvre le besoin*: Comment le client reconnaît-il son besoin ou son problème?
* *Le besoin du client est résolu*: Comment le besoin du client est-il finalement résolu?
* *Étapes du parcours*: Quelles sont les étapes suivies par le client dans son parcours?
* *Douleurs*: Quels sont les irritants ou défis du client?
* *Gains*: Quels sont les gains ou bénéfices pour le client?
* *Entrées et sorties*: Quelles sont les entrées et les sorties à chaque étape?
* *Règles d'interaction et de traitement*: Quelles sont les règles d'interaction et de traitement à chaque étape?
#### Domain Canvas
Quels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?
* *Étapes du parcours client sélectionnées*: Quelles étapes du parcours client sont pertinentes pour ce domaine?
* *Entités principales et signification métier*: Quelles sont les entités principales et leur signification métier?
* *Attributs et importance métier*: Quels sont les attributs clés de chaque entité et leur importance métier?
* *Relations entre les entités*: Quelles sont les relations entre les entités?
* *Règles métier, conformité et intégrité*: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?
* *Considérations de sécurité et de confidentialité*: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?
#### Capability Value Proposition Canvas
Quelle capacité réutilisable créerait de la valeur pour les utilisateurs sans décider encore si elle doit être mise à disposition sous forme d’API, d’événement, de fichier, de flux, de produit de données ou d’un autre mode de mise en œuvre ?
* *Tâches et résultats des utilisateurs*: Que cherchent à accomplir les utilisateurs, partenaires, systèmes ou équipes ?
* *Fonctionnalités de capacité génératrices de gains*: Quelles fonctionnalités de capacité aideraient les utilisateurs à obtenir de meilleurs résultats, plus de rapidité, d’automatisation, d’insights, de portée ou de conformité ?
* *Fonctionnalités de capacité qui réduisent les irritants*: Quelles fonctionnalités de capacité supprimeraient les frictions, le travail manuel, les erreurs, les retards, les risques ou l’incertitude pour les utilisateurs ?
* *Capacités réutilisables*: Quelles capacités métier ou données réutilisables pourraient répondre à ces tâches, gains et irritants pour plusieurs utilisateurs ou cas d’usage ?
#### Capability Business Model Canvas
Dans quelle mesure cette capacité d’intégration doit-elle être viable, réutilisable, financée, possédée, accompagnée et découvrable ?
* *Proposition de valeur de la capacité*: Quelle valeur cette capacité réutilisable apporte-t-elle aux utilisateurs et à l’organisation ou à l’écosystème ?
* *Segments d’utilisateurs de la capacité*: Qui sont les utilisateurs actuels et potentiels de la capacité, y compris équipes, partenaires, systèmes, produits ou utilisateurs de données ?
* *Engagement des utilisateurs*: Comment les utilisateurs découvriront-ils, évalueront-ils, demanderont-ils, onboarderont-ils, obtiendront-ils du support et donneront-ils du feedback sur la capacité ?
* *Canaux*: Par quels catalogues, portails, marketplaces, sites de documentation, parcours de support ou processus de gouvernance les utilisateurs interagiront-ils avec la capacité ?
* *Ressources clés*: Quels systèmes, actifs de données, plateformes, personnes, standards, financements et capacités opérationnelles sont nécessaires ?
* *Activités clés*: Que doivent faire le responsable de la capacité et les producteurs pour concevoir, mettre à disposition, gouverner, accompagner et améliorer la capacité ?
* *Partenaires clés*: Quels partenaires métier, technologie, données, sécurité, juridique, plateforme ou externes sont nécessaires pour faire fonctionner la capacité ?
* *Bénéfices*: Quels bénéfices métier, opérationnels, écosystémiques, de réutilisation, de conformité ou de coût justifient la capacité ?
* *Coûts*: Quels sont les coûts significatifs de construction, d’exploitation, de gouvernance, de support et d’évolution de la capacité ?
h2. 2. Exigences des utilisateurs d’intégration & onboarding
Capturez les utilisateurs d’intégration, les responsabilités des fournisseurs, les besoins d’onboarding, les attentes de service et les contraintes opérationnelles.
h3. Canvas questions
#### Consumer Experience Requirements Canvas
Quelles exigences d’expérience et non fonctionnelles les utilisateurs doivent-ils préciser avant de décider de la meilleure architecture d’intégration ?
* *Objectifs des utilisateurs*: Quels sont les objectifs métier, de workflow, de décision, d’automatisation ou d’usage des données des utilisateurs ?
* *Disponibilité et fraîcheur*: Quand la capacité doit-elle être disponible, quelle fraîcheur d’information est nécessaire et quelles fenêtres de latence ou de mise à disposition comptent ?
* *Volume et performance*: Quels volumes de requêtes, événements, enregistrements, fichiers, lots, utilisateurs ou transactions la capacité doit-elle supporter aujourd’hui et demain ?
* *Qualité et cohérence des données*: Quelles attentes les utilisateurs ont-ils en matière d’exactitude, complétude, cohérence, ordre, déduplication, rapprochement ou validation ?
* *Sécurité, protection des données et conformité*: Quelles contraintes d’identité, d’autorisation, de confidentialité, de résidence, de consentement, de conservation, d’audit ou de réglementation s’appliquent ?
* *Onboarding et accès*: Comment les utilisateurs doivent-ils trouver, demander, tester, obtenir l’approbation et commencer à utiliser la capacité ?
* *Changement et versionnement*: Quelle tolérance au changement les utilisateurs ont-ils, et quelles attentes de préavis, compatibilité, migration ou versionnement s’appliquent ?
* *Observabilité et support*: De quelle surveillance, information de statut, traçabilité, visibilité sur la qualité des données, support, propriété et communication d’incident les utilisateurs ont-ils besoin ?
* *Reprise et continuité*: Quelles attentes de replay, retry, rapprochement, sauvegarde, fallback, continuité ou reprise manuelle doivent être prises en charge ?
* *Implications d’architecture*: Que signifient ces exigences pour les styles d’architecture possibles, tels que API, événements, fichiers, flux, produits de données ou intégration directe ?
h3. Other related resources
* *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.
h2. 3. Architecture d integration & decisions de plateforme
Choisir l architecture d integration, le mode de mise en oeuvre et les capacites de plateforme en tenant compte des contraintes et du modele de gouvernance.
h3. Canvas questions
#### Business Impact Canvas
Quels impacts métier une défaillance ou un mauvais comportement de la capacité ou de l’interface peut-il avoir ?
* *Risques de disponibilité*: Quels sont les risques potentiels pour la disponibilité de l’API?
* *Atténuer les risques de disponibilité*: Comment le fournisseur d’API peut-il atténuer les risques de disponibilité?
* *Risques de sécurité*: Quels sont les risques de sécurité potentiels associés à l’API?
* *Atténuer les risques de sécurité*: Comment le fournisseur d’API peut-il atténuer les risques de sécurité?
* *Risques liés aux données*: Quels sont les risques potententiels pour l'intégrité ou la protection des données?
* *Atténuer les risques liés aux données*: Comment le fournisseur d’API peut-il atténuer les risques liés aux données?
#### Location Canvas
Quelles frontières géopolitiques, réglementaires, réseau et de confiance affectent cette capacité ou interface ?
* *Groupes de localisation / de confiance*: Quels sont les groupes géopolitiques, réglementaires, de réseau ou de confiance pertinents ?
* *Caractéristiques des groupes*: uelles sont les caractéristiques de ces groupes, telles que la localisation, le niveau de confiance ou l'exposition réseau ?
* *Emplacements / Zones pertinents*: Quels sont les emplacements, zones ou environnements pertinents au sein de chaque groupe ?
* *Caractéristiques des emplacements / zones*: Quelles sont les caractéristiques de ces emplacements ou zones, telles que la propriété, la région ou l'exposition ?
* *Distances réseau / réglementaires*: Quelles sont les distances en termes de latence, de confiance, de réglementation ou de connectivité entre les emplacements ?
* *Caractéristiques des distance*: Quelles sont les caractéristiques de ces distances, telles que la sensibilité à la latence, les contraintes de résidence ou les limites de confiance ?
* *Points de terminaison de connectivité*: Quels sont les points de terminaison ou interfaces de connectivité associés aux emplacements ?
* *Caractéristiques d'accès aux points de terminaison*: Quelles sont les caractéristiques de ces points de terminaison, telles que l'exposition, le protocole, la sécurité ou les restrictions d'accès ?
#### Capacity Canvas
Quelle capacité est nécessaire pour soutenir l’usage de la capacité ou de l’interface ?
* *Volumes d'activité actuels*: Quels sont les volumes d'affaires et taux de transaction actuels?
* *Tendances de consommation futures*: Quelles sont les tendances de consommation anticipées?
* *Exigences de charge maximale et de disponibilité*: Quelles sont les exigences de charge maximale et de disponibilité?
* *Stratégies de mise en cache*: Quelles stratégies de mise en cache peuvent être utilisées pour optimiser les performances?
* *Stratégies de limitation de débit*: Quelles stratégies de limitation de débit peuvent être utilisées pour gérer la consommation?
* *Stratégies de montée en charge*: Quelles stratégies d'évolutivité peuvent être utilisées pour accompagner la croissance?
h3. Other related resources
* *Lignes directrices pour l'intégration des partenaires*: Listes de contrôle de l'intégration et modèles de communication pour gérer les aspects techniques et juridiques des relations avec des API tierces.
h2. 4. Conception de solution d’intégration
Concevoir le contrat d interface, les schemas, les payloads et les modeles d interaction pour le style d integration choisi.
h3. Canvas questions
#### Domain Canvas
Quels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?
* *Étapes du parcours client sélectionnées*: Quelles étapes du parcours client sont pertinentes pour ce domaine?
* *Entités principales et signification métier*: Quelles sont les entités principales et leur signification métier?
* *Attributs et importance métier*: Quels sont les attributs clés de chaque entité et leur importance métier?
* *Relations entre les entités*: Quelles sont les relations entre les entités?
* *Règles métier, conformité et intégrité*: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?
* *Considérations de sécurité et de confidentialité*: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?
#### Interaction Canvas
Quels types d’interactions cette capacité ou interface doit-elle prendre en charge avant de choisir une conception propre au protocole ?
* *Interactions CRUD*: Quelles interactions CRUD (Create, Read, Update, Delete) sont-elles nécessaires ici?
* *Modèles d'entrée et de sortie CRUD*: Quels sont les modèles d'entrée et de sortie pour les interactions CRUD, si ce style est nécessaire ?
* *Traitement et validation CRUD*: QQuelles sont les règles de traitement et de validation pour les interactions CRUD, si ce style est nécessaire ?
* *Interactions pilotées par requêtes*: Quelles interactions de lecture ou de requête sont nécessaires pour répondre aux questions des utilisateurs ?
* *Modèles d'entrée et de sortie pilotés par les requêtes*: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par les requêtes ?
* *Traitement et validation pilotés par les requêtes*: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les requêtes ?
* *Interactions pilotées par commandes*: Quelles commandes modifiant l'état sont nécessaires, le cas échéant ?
* *Modèles d'entrée et de sortie pilotés par commande*: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par commande, si ce style est nécessaire ?
* *Traitement et validation pilotés par les commandes*: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les commandes, si ce style est nécessaire ?
* *Interactions pilotées par les événements*: Quels événements doivent être publiés ou consommés, le cas échéant ?
* *Modèles d'entrée et de sortie pilotés par les événements*: Modèles d'entrée et de sortie pilotés par les événements
* *Traitement et validation pilotés par les événements*: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les événements, si ce style est requis ?
#### REST Canvas
Comment concevoir l’API selon les principes RESTful ?
* *Ressources API*: Quelles sont les ressources clés exposées par l’API?
* *Modèle de ressource API*: Quelle est la structure du modèle de ressources de l’API?
* *Verbes API*: Quels verbes HTTP sont utilisés pour interagir avec les ressources de l’API?
* *Exemple de verbe API*: Fournissez un exemple de requête et de réponse API pour chaque verbe.
#### Event Canvas
Quels événements sont pertinents pour la capacité ou l’interface, et comment sont-ils traités ?
* *Tâche utilisateur / Déclencheur*: Quelle action utilisateur ou événement système déclenche cette opération d'événement?
* *Entrée / Charge utile de l'événement*: Quelles données sont incluses dans la charge utile de l'événement entrant? Spécifiez les attributs clés.
* *Traitement / Logique*: Décrivez la logique de traitement systèmes backend, y compris les validations, transformations ou décisions de routage.
* *Sortie / Résultat de l'événement*: Quel événement ou accusé de réception est produit? Incluez les attributs de la charge utile de sortie.
#### GraphQL Canvas
Comment concevoir l’API selon les principes GraphQL ?
* *Nom de l’API*: Quel est le nom de l’API GraphQL ou du point de terminaison ?
* *Objectifs des utilisateurs*: Quels problèmes les utilisateurs de l’API cherchent-ils à résoudre ? Quelles données leur sont nécessaires ?
* *Types clés*: Quels sont les types principaux exposés (ex. Utilisateur, Commande, Produit) ?
* *Relations*: Comment les types sont-ils liés dans les requêtes imbriquées ?
* *Requêtes*: Quelles requêtes courantes doivent être prises en charge ?
* *Mutations*: Quelles opérations vont modifier les données (ex. créer, mettre à jour, supprimer) ?
* *Abonnements*: Existe-t-il des mises à jour en temps réel ou des événements auxquels les utilisateurs peuvent s'abonner ?
* *Règles d'autorisation*: Qui peut accéder à quels champs ou types ?
* *Contraintes des utilisateurs*: Y a-t-il des contraintes de pagination, de filtrage ou de limitation du débit ?
* *Notes / Questions ouvertes*: Y a-t-il des décisions en attente ou des considérations d’intégration ?
h3. Other related resources
* *Guide de sélection du mode d’intégration*: Guide pour choisir entre API, événement, fichier, flux, produit de données, intégration directe ou mode hybride selon les exigences et contraintes.
* *Contrat de première conception*: Une ligne directrice qui préconise des approches "API-first" utilisant des contrats formels (par exemple, OpenAPI) pour aligner les parties prenantes avant le développement.
h2. 5. Livraison & opérations d’intégration
Construire, tester, automatiser, deployer et exploiter la capacite d integration avec le mode de mise en oeuvre choisi et le contrat d interface valide.
h3. Station questions
* Utilisez les pratiques de développement pour implémenter le contrat d'interface validé avec les frameworks, bibliothèques et standards d'équipe établis.
* Construisez l'implémentation de l'API à partir du contrat validé en utilisant des frameworks, des bibliothèques et des normes d'équipe établis.
* Tester les fonctionnalités, la sécurité et les performances des API à l'aide d'outils de test automatisés.
* Utiliser les pipelines CI/CD pour automatiser les processus de construction, de test et de déploiement, en garantissant une qualité et une traçabilité constantes.
* S'assurer que les API répondent aux exigences de sécurité et de conformité grâce à des contrôles et des audits automatisés.
* Utilisez la liste de contrôle de l'audit de l'API pour vous assurer que l'API répond aux exigences fonctionnelles et non fonctionnelles, notamment en matière de sécurité, de performances et de conformité.
* Appliquez les pratiques de mise en œuvre, de test, de CI/CD, d'exploitation et de sécurité au mode de mise en œuvre choisi.
* Une capacité réutilisable a besoin d'une mise à disposition et d'un fonctionnement fiables, qu'elle soit réalisée sous forme d'API, de flux d'événements, d'échange de fichiers, de produit de données ou d'intégration directe.
h3. Other related resources
* *Meilleures pratiques en matière de développement d'API*: Guide de mise en œuvre pour transformer un contrat d’interface API validé en une base de code API cohérente et maintenable, à l’aide de bibliothèques standard, de modèles réutilisables et de workflows de développement harmonisés.
* *Meilleures pratiques de test de l'API*: Lignes directrices pour la mise en œuvre de tests fonctionnels, de performance et de sécurité automatisés tout au long du cycle de vie de l'API.
* *APIOps CI/CD pour les API*: Des conseils de déploiement qui intègrent les tâches du cycle de vie de l'API - conception, test, gouvernance - dans les pipelines d'intégration et de livraison en continu.
* *Meilleures pratiques en matière de sécurité des API*: Un ensemble de contrôles exploitables pour sécuriser les API, y compris l'authentification, l'autorisation, le cryptage, la limitation du débit et les contrôles de conformité au niveau du pipeline.
* *Lignes directrices pour l'intégration des partenaires*: Listes de contrôle de l'intégration et modèles de communication pour gérer les aspects techniques et juridiques des relations avec des API tierces.
h2. 6. Assurance qualité des intégrations
Assurez la préparation, la gouvernance, la qualité, la sécurité, la conformité et les preuves opérationnelles de l’intégration avant publication.
h3. Station questions
* Utilisez des checklists, linters, tests et revues pour vérifier cohérence, standards, sécurité, performance et conformité.
* 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.
* Collaborer avec les équipes de gouvernance et les experts du domaine pour s'assurer que les API sont prêtes pour la production.
* Utilisez les ressources d'audit et de conformité pour vérifier que la capacité peut être publiée et réutilisée de manière contrôlée.
* Les capacités réutilisables créent des risques opérationnels, liés aux données, à la sécurité, à la confidentialité, à la conformité et à l'expérience utilisateur. Les revues de préparation réduisent les surprises avant la publication ou l'utilisation en production.
h3. Other related resources
* *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.
* *Meilleures pratiques en matière de conformité de l'API*: Veiller à ce que les API respectent la conformité légale, réglementaire et interne grâce à la documentation, aux contrôles et aux validations automatisées.
h2. 7. Publication & enablement de l integration
Publier la capacite d integration afin que les equipes puissent la decouvrir, l evaluer, demander l acces, terminer l onboarding, la reutiliser et obtenir du support.
h3. Station questions
* Publiez les informations de capacité dans les catalogues, portails, passerelles ou environnements appropriés afin que plusieurs utilisateurs puissent la réutiliser.
* Documenter la manière dont les utilisateurs trouvent et utilisent l'API, y compris les processus d'accueil et d'enregistrement.
* Veiller à ce que les modèles de sécurité, la configuration de la passerelle et les termes juridiques soient clairs et accessibles aux utilisateurs.
* Publiez la responsabilité, la documentation, l'onboarding, les contacts support, les attentes de service, le statut de cycle de vie et les chemins d'accès.
* Une capacité réutilisable ne crée de la valeur que si les utilisateurs peuvent la trouver, comprendre le contrat d'interface et les attentes de service, demander l'accès et connaître le support ainsi que la responsabilité du cycle de vie.
h3. Other related resources
* *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.
* *Modèle de contrat de service*: Un format d'accord personnalisable qui définit les attentes, les accords de niveau de service, les responsabilités et les conditions d'accès pour la consommation d'API.
h2. 8. Suivi & amélioration des intégrations
Suivez la fiabilité, la réutilisation, les incidents, la performance, les résultats utilisateurs et les besoins d’amélioration de l’intégration.
h3. Station questions
* Définissez des métriques d'utilisation, fiabilité, qualité des données, coût, adoption et valeur utilisateur.
* Analyser les indicateurs d'utilisation de l'API et intégrer les commentaires des utilisateurs dans les itérations de l'API.
* Prendre l'habitude d'examiner les mesures et de planifier des activités d'amélioration continue.
* Utilisez des métriques, analyses et pratiques de feedback pour améliorer continuellement la capacité.
* Les capacités ont besoin de retours continus pour rester fiables, utiles, économiquement pertinentes et réutilisables lorsque les utilisateurs, systèmes, données et plateformes évoluent.
h3. Other related resources
* *Mesures et analyses de l'API*: Une ressource pour définir, collecter et analyser les performances de l'API et les données d'utilisation afin d'aligner les KPI techniques sur les résultats de l'entreprise.
* *Stratégies d'engagement de la communauté de l'API*: Un guide pour favoriser l'adoption des API en cultivant des communautés grâce à des contenus, des canaux d'assistance, des boucles de retour d'information et des stratégies d'engagement social.