Avant de construire quoi que ce soit, définissez dès le départ la valeur de votre API, ses utilisateurs et ses objectifs métier.
De nombreuses organisations considèrent les API comme des projets technologiques et non comme des produits. Le résultat ? Des utilisateurs désorientés, une adoption médiocre et un gaspillage d'efforts.
Cette station vous aide à définir l'objectif, le public cible et les critères de réussite de votre API, afin que les équipes puissent fournir des API qui résolvent des problèmes réels.
Veillez à ce que votre API soit découvrable, compréhensible et utilisable - avant et après le lancement.
Les meilleures API ne se contentent pas de fonctionner, elles sont intuitives. Que votre utilisateur soit un développeur interne, un partenaire externe ou un agent d'intelligence artificielle, c'est son expérience qui détermine l'adoption.
Sans un plan d'expérience clair :
- Les meilleures API restent inutilisées
- Les équipes perdent du temps à deviner comment utiliser votre API.
- Les boucles de rétroaction sont brisées ou manquantes.
Cette station vous aide à voir votre API à travers les yeux de ses utilisateurs.
Assurez l'évolutivité, la réutilisation et la gouvernance de vos composants d'API et de plateforme.
Lorsque les API s'étendent à plusieurs équipes, votre plateforme doit permettre la gouvernance et la réutilisation sans bloquer la vitesse. Cette station montre comment architecturer les API pour assurer leur longévité, leur sécurité et leur efficacité.
Créer des architectures d'API cohérentes, réutilisables et fondées sur les objectifs métier et des normes communes.
La conception d'API ne se limite pas à nommer des points de terminaison. Une bonne conception garantit que les API sont utilisables, cohérentes et alignées sur les objectifs métier et techniques. Une mauvaise conception entraîne un couplage étroit, une faible réutilisation et des retouches coûteuses entre les équipes.
Construire, tester et publier des API en utilisant des pipelines de livraison modernes et les meilleures pratiques d'ingénierie.
Même les meilleures conceptions d'API échouent si la livraison est incohérente. Cette station garantit que vos API sont construites avec qualité, testées de manière approfondie et déployées de manière fiable, ce qui permet des itérations plus rapides et une plus grande confiance.
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.
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.
Utiliser les mesures et le retour d'information pour suivre les performances de l'API et favoriser l'amélioration continue.
La livraison d'API ne s'arrête pas au lancement. Sans surveillance, les équipes ne peuvent pas améliorer l'adoption, les performances ou le retour sur investissement. Cette station garantit que les API restent utiles, sécurisées et qu'elles évoluent avec les besoins de l'entreprise.
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 API question template
Parcours APIOps Cycles centré sur les API pour productiser, concevoir, livrer, publier et améliorer des produits API.
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 produit API
Avant de construire quoi que ce soit, définissez dès le départ la valeur de votre API, ses utilisateurs et ses objectifs métier.
### 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?
#### API Value Proposition Canvas
Comment le parcours client est-il lié aux API ? Quels irritants et gains des utilisateurs finaux et des utilisateurs API doivent être traités ?
- **Tâches**: Que cherchent à accomplir les clients ou utilisateurs finaux ?
- **Fonctionnalités génératrices de gains**: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à obtenir les gains attendus ?
- **Fonctionnalités qui réduisent les irritants**: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à réduire les irritants ?
- **Produits API**: Quels produits et fonctionnalités API répondent aux tâches, peines et gains?
#### API Business Model Canvas
Quelle sera la viabilité et la réutilisabilité de cette API ? Existe-t-il un modèle métier justifié du point de vue coût-bénéfice ?
- **Proposition de valeur de l’API**: Commencez par une note adhésive indiquant le nom de l’API ou de la famille d’API, puis notez la valeur ajoutée que l’API offre aux utilisateurs API.
- **Segments d’utilisateurs API**: Quelles sont les audiences cibles pour l’API?
- **Relations développeurs**: Comment le fournisseur d’API atteint-il et soutient-il les utilisateurs API?
- **Canaux**: Par quels mécanismes les utilisateurs API interagissent-ils avec l’API?
- **Ressources clés**: Quels actifs stratégiques uniques le fournisseur d’API doit-il acquérir ou développer?
- **Activités clés**: Quelles sont les actions les plus importantes que le fournisseur d’API doit entreprendre pour réussir?
- **Partenaires clés**: Qui sont les principales parties prenantes impliquées?
- **Avantages**: Quels sont les avantages significatifs ou les sources de revenus générés par l’API?
- **Coûts**: Quels sont les coûts importants liés à la création, au déploiement et à l'exploitation de l’API?
## 2. Expérience utilisateur API
Veillez à ce que votre API soit découvrable, compréhensible et utilisable - avant et après le lancement.
### Canvas questions
#### API Value Proposition Canvas
Comment le parcours client est-il lié aux API ? Quels irritants et gains des utilisateurs finaux et des utilisateurs API doivent être traités ?
- **Tâches**: Que cherchent à accomplir les clients ou utilisateurs finaux ?
- **Fonctionnalités génératrices de gains**: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à obtenir les gains attendus ?
- **Fonctionnalités qui réduisent les irritants**: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à réduire les irritants ?
- **Produits API**: Quels produits et fonctionnalités API répondent aux tâches, peines et gains?
#### 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?
### 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 de plateforme API
Assurez l'évolutivité, la réutilisation et la gouvernance de vos composants d'API et de plateforme.
### 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
- **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.
## 4. Conception d’API
Créer des architectures d'API cohérentes, réutilisables et fondées sur les objectifs métier et des normes communes.
### 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
- **Principes de conception de l'API**: Un guide concis sur l'ergonomie, la facilité de découverte et la cohérence des API, fondé sur des règles de conception communes et les besoins réels des consommateurs.
- **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 d’API
Construire, tester et publier des API en utilisant des pipelines de livraison modernes et les meilleures pratiques d'ingénierie.
### Station questions
- Utilisez les meilleures pratiques de développement d'API comme guide pour mettre en œuvre le contrat d'interface validé à l'aide de frameworks et de bibliothèques établis, en veillant à ce que le résultat soit réutilisable et maintenable.
- Construisez l'implémentation de l'API à partir du contrat d'interface validé en utilisant des frameworks, des bibliothèques et des standards 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é.
- Fournir des frameworks de développement, des bibliothèques et des normes pour la mise en œuvre des API. Mettre en œuvre des pipelines CI/CD, des cadres d'assurance qualité et des outils d'automatisation du déploiement.
- Même les meilleures conceptions d'API échouent si la livraison est incohérente. Cette station garantit que vos API sont construites avec qualité, testées de manière approfondie et déployées de manière fiable, ce qui permet des itérations plus rapides et une plus grande confiance.
### 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.
## 6. 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.
### Station questions
- Mener des audits pour s'assurer que les API respectent les normes organisationnelles, techniques et juridiques avant d'être publiées.
- 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.
- 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.
- 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.
### 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 d’API
Exposer les API de manière sûre et claire au bon public avec la bonne documentation et les bons processus.
### Station questions
- Publier les API dans les passerelles et les environnements appropriés afin de favoriser la réutilisation pour de multiples utilisateurs.
- 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.
- 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é.
- 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.
### Other related resources
- **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 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.
- **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.
## 8. Suivi & amelioration API
Utiliser les mesures et le retour d'information pour suivre les performances de l'API et favoriser l'amélioration continue.
### Station questions
- Contrôler les indicateurs de performance (par exemple, les appels à l'API, la latence, les taux d'erreur) et les indicateurs d'adoption (par exemple, NPS).
- 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.
- Mettre en place des cadres d'analyse pour suivre les performances et l'engagement. Développer des boucles de rétroaction, des outils d'analyse et des stratégies d'engagement pour les API.
- La livraison d'API ne s'arrête pas au lancement. Sans surveillance, les équipes ne peuvent pas améliorer l'adoption, les performances ou le retour sur investissement. Cette station garantit que les API restent utiles, sécurisées et qu'elles évoluent avec les besoins de l'entreprise.
### 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 API question template
Parcours APIOps Cycles centré sur les API pour productiser, concevoir, livrer, publier et améliorer des produits API.
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 produit API
Avant de construire quoi que ce soit, définissez dès le départ la valeur de votre API, ses utilisateurs et ses objectifs métier.
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?
#### API Value Proposition Canvas
Comment le parcours client est-il lié aux API ? Quels irritants et gains des utilisateurs finaux et des utilisateurs API doivent être traités ?
* *Tâches*: Que cherchent à accomplir les clients ou utilisateurs finaux ?
* *Fonctionnalités génératrices de gains*: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à obtenir les gains attendus ?
* *Fonctionnalités qui réduisent les irritants*: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à réduire les irritants ?
* *Produits API*: Quels produits et fonctionnalités API répondent aux tâches, peines et gains?
#### API Business Model Canvas
Quelle sera la viabilité et la réutilisabilité de cette API ? Existe-t-il un modèle métier justifié du point de vue coût-bénéfice ?
* *Proposition de valeur de l’API*: Commencez par une note adhésive indiquant le nom de l’API ou de la famille d’API, puis notez la valeur ajoutée que l’API offre aux utilisateurs API.
* *Segments d’utilisateurs API*: Quelles sont les audiences cibles pour l’API?
* *Relations développeurs*: Comment le fournisseur d’API atteint-il et soutient-il les utilisateurs API?
* *Canaux*: Par quels mécanismes les utilisateurs API interagissent-ils avec l’API?
* *Ressources clés*: Quels actifs stratégiques uniques le fournisseur d’API doit-il acquérir ou développer?
* *Activités clés*: Quelles sont les actions les plus importantes que le fournisseur d’API doit entreprendre pour réussir?
* *Partenaires clés*: Qui sont les principales parties prenantes impliquées?
* *Avantages*: Quels sont les avantages significatifs ou les sources de revenus générés par l’API?
* *Coûts*: Quels sont les coûts importants liés à la création, au déploiement et à l'exploitation de l’API?
h2. 2. Expérience utilisateur API
Veillez à ce que votre API soit découvrable, compréhensible et utilisable - avant et après le lancement.
h3. Canvas questions
#### API Value Proposition Canvas
Comment le parcours client est-il lié aux API ? Quels irritants et gains des utilisateurs finaux et des utilisateurs API doivent être traités ?
* *Tâches*: Que cherchent à accomplir les clients ou utilisateurs finaux ?
* *Fonctionnalités génératrices de gains*: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à obtenir les gains attendus ?
* *Fonctionnalités qui réduisent les irritants*: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à réduire les irritants ?
* *Produits API*: Quels produits et fonctionnalités API répondent aux tâches, peines et gains?
#### 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?
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 de plateforme API
Assurez l'évolutivité, la réutilisation et la gouvernance de vos composants d'API et de plateforme.
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
* *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.
h2. 4. Conception d’API
Créer des architectures d'API cohérentes, réutilisables et fondées sur les objectifs métier et des normes communes.
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
* *Principes de conception de l'API*: Un guide concis sur l'ergonomie, la facilité de découverte et la cohérence des API, fondé sur des règles de conception communes et les besoins réels des consommateurs.
* *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 d’API
Construire, tester et publier des API en utilisant des pipelines de livraison modernes et les meilleures pratiques d'ingénierie.
h3. Station questions
* Utilisez les meilleures pratiques de développement d'API comme guide pour mettre en œuvre le contrat d'interface validé à l'aide de frameworks et de bibliothèques établis, en veillant à ce que le résultat soit réutilisable et maintenable.
* Construisez l'implémentation de l'API à partir du contrat d'interface validé en utilisant des frameworks, des bibliothèques et des standards 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é.
* Fournir des frameworks de développement, des bibliothèques et des normes pour la mise en œuvre des API. Mettre en œuvre des pipelines CI/CD, des cadres d'assurance qualité et des outils d'automatisation du déploiement.
* Même les meilleures conceptions d'API échouent si la livraison est incohérente. Cette station garantit que vos API sont construites avec qualité, testées de manière approfondie et déployées de manière fiable, ce qui permet des itérations plus rapides et une plus grande confiance.
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.
h2. 6. 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.
h3. Station questions
* Mener des audits pour s'assurer que les API respectent les normes organisationnelles, techniques et juridiques avant d'être publiées.
* 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.
* 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.
* 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.
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 d’API
Exposer les API de manière sûre et claire au bon public avec la bonne documentation et les bons processus.
h3. Station questions
* Publier les API dans les passerelles et les environnements appropriés afin de favoriser la réutilisation pour de multiples utilisateurs.
* 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.
* 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é.
* 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.
h3. Other related resources
* *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 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.
* *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.
h2. 8. Suivi & amelioration API
Utiliser les mesures et le retour d'information pour suivre les performances de l'API et favoriser l'amélioration continue.
h3. Station questions
* Contrôler les indicateurs de performance (par exemple, les appels à l'API, la latence, les taux d'erreur) et les indicateurs d'adoption (par exemple, NPS).
* 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.
* Mettre en place des cadres d'analyse pour suivre les performances et l'engagement. Développer des boucles de rétroaction, des outils d'analyse et des stratégies d'engagement pour les API.
* La livraison d'API ne s'arrête pas au lancement. Sans surveillance, les équipes ne peuvent pas améliorer l'adoption, les performances ou le retour sur investissement. Cette station garantit que les API restent utiles, sécurisées et qu'elles évoluent avec les besoins de l'entreprise.
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.