Intégration API

Runbook incident API : quoi faire quand un flux critique tombe

Jérémy Chomel Dawap
  • Publié le : 19 septembre 2024
  • Mis à jour le : 10 août 2026
  • Temps de lecture : 13 minutes
  1. Décider avant que la pression ne dicte les actions
  2. Savoir quand activer le mode incident
  3. Attribuer commandement, diagnostic et communication
  4. Qualifier impact, périmètre et chronologie
  5. Prioriser les flux qui protègent cash et clients
  6. Préserver les preuves avant toute correction
  7. Contenir la dérive sans arrêter tout le SI
  8. Reprendre par lots idempotents et contrôlés
  9. Informer chaque audience avec une vérité stable
  10. Choisir retour arrière ou correction ciblée
  11. Tester le mode opératoire avant la panne
  12. Piloter une panne fournisseur et une dérive silencieuse
  13. Éviter les erreurs fréquentes sous pression
  14. Déployer un dispositif actionnable en quatre semaines
  15. Lectures complémentaires pour fiabiliser la reprise
  16. Conclusion : répéter sans improviser
Portrait de Jérémy Chomel

Le vrai enjeu d’un runbook d’incident API n’est pas de documenter toute l’architecture. Il consiste à donner un ordre de décision partagé lorsque des commandes, paiements, stocks, factures ou données clients cessent de circuler correctement et que chaque minute augmente la pression.

Le risque est d’agir trop largement : relancer tous les messages, corriger directement une base, couper un service sain ou annoncer un retour à la normale avant la réconciliation. Ces réflexes créent des doublons, effacent les preuves et transforment une panne technique en dette métier durable.

Une intégration API fiable prépare donc la qualification, le containment, la communication et la reprise avant l’incident. Les personnes savent qui commande, quelles données préserver et quels seuils autorisent chaque étape.

En réalité, ralentir quelques minutes pour borner le périmètre fait souvent gagner des heures. Une décision explicable vaut mieux qu’une correction immédiate dont personne ne peut ensuite mesurer l’effet sur les systèmes et les clients.

La règle sous pression

Arrêtez d’abord la création de nouveaux écarts, préservez les preuves, puis reprenez seulement les objets dont l’état cible a été vérifié. La vitesse vient de l’ordre, pas de la multiplication des actions.

Préparer vos flux critiques

Décider avant que la pression ne dicte les actions

Un incident critique provoque plusieurs urgences simultanées. L’exploitation cherche la cause, le support veut répondre, la finance veut connaître les montants et la direction demande une estimation. Sans séquence convenue, chacun agit sur sa partie et la chronologie devient plus difficile à reconstruire.

Le mode opératoire réduit le nombre de décisions nouvelles. Il fixe les étapes, les critères d’escalade, les droits d’arrêt et les canaux de communication. Les personnes gardent leur jugement pour les exceptions réelles au lieu de rediscuter des règles de base au pire moment.

Sa qualité se mesure par des résultats : temps de qualification, volume d’écarts supplémentaires, durée de reprise et capacité à expliquer ce qui a été corrigé. Un document long mais jamais exercé protège moins qu’une page actionnable reliée aux tableaux et aux commandes nécessaires.

Savoir quand activer le mode incident

Toute erreur ne mérite pas une cellule de crise. L’activation dépend de l’impact, de la vitesse de propagation et de la capacité du traitement normal à rattraper. Une file secondaire ralentie peut rester sous surveillance ; une commande dupliquée ou un paiement ambigu exige une coordination immédiate.

Les déclencheurs combinent des seuils techniques et métier : indisponibilité supérieure à cinq minutes, backlog dépassant la fenêtre de rattrapage, montants non rapprochés ou plainte client confirmant une mauvaise décision. Un seuil isolé peut produire du bruit ; la combinaison indique le risque réel.

Le retour au fonctionnement normal possède lui aussi des critères. Le service doit répondre, la file doit décroître, l’échantillon réconcilié doit être juste et les équipes doivent connaître les écarts encore ouverts. Fermer sur la seule disparition de l’alerte laisse souvent une dette invisible.

Attribuer commandement, diagnostic et communication

La personne qui commande l’incident protège l’ordre des décisions et le rythme des points de situation. Elle ne réalise pas toutes les analyses. Un responsable technique cherche la cause, un référent métier mesure l’impact et une personne dédiée maintient la communication interne ou externe.

Les rôles de support, finance, commerce et logistique sont prévus selon le flux. Chacun sait quelles informations fournir et quelles actions éviter. Les droits d’arrêt, de déploiement et de reprise sont explicites afin qu’une intervention urgente ne dépende pas d’un accès détenu par une seule personne absente.

Organiser les passations sans perdre la chronologie

Un incident long dépasse parfois une équipe ou un fuseau horaire. La passation résume l’impact actuel, les hypothèses invalidées, les actions en cours, les décisions prises et le prochain jalon. Elle pointe vers les preuves au lieu de recopier des messages dispersés.

Le journal de commandement enregistre heure, auteur, décision et résultat attendu. Cette discipline évite de répéter un test déjà négatif ou d’annuler une mesure de containment sans comprendre pourquoi elle avait été choisie.

Qualifier impact, périmètre et chronologie

La qualification répond à six questions : quel flux, depuis quand, quels objets, quel volume, quel impact et quels systèmes sont concernés ? Elle distingue panne totale, dérive partielle, retard, rejet fonctionnel et incohérence de données. Le remède dépend de cette catégorie.

La chronologie part du dernier état connu sain, puis recense déploiements, changements de configuration, quotas, incidents fournisseurs et pics de volume. Une corrélation temporelle nourrit l’hypothèse, mais ne prouve pas la cause. Chaque test doit confirmer ou invalider sans modifier inutilement la production.

Construire un périmètre minimal vérifiable

Par exemple, « commandes du canal B reçues entre 09 h 20 et 09 h 47, écriture ERP inconnue après timeout » est actionnable. « L’API commandes est cassée » ne dit ni quoi contenir ni quels objets réconcilier. La précision protège les flux sains.

Le support confirme le symptôme avec des identifiants réels, tandis que les métriques estiment l’étendue. Croiser plainte, logs et état cible évite d’extrapoler depuis un dossier isolé ou, à l’inverse, de sous-estimer une dérive silencieuse.

Prioriser les flux qui protègent cash et clients

Commandes, paiements, stocks, factures, remboursements et leads chauds n’ont pas la même fenêtre de tolérance qu’un enrichissement catalogue. La priorité combine perte potentielle, promesse client, obligations, capacité de rattrapage et risque de produire une donnée fausse.

Un flux arrêté mais rejouable peut être moins urgent qu’un flux encore actif qui duplique des écritures. Le premier accumule du retard visible ; le second augmente l’écart à chaque minute. Contenir la dérive active passe donc avant l’accélération d’un backlog maîtrisé.

Le classement précise aussi ce qui peut être différé. Les enrichissements, exports analytiques et notifications secondaires restent suspendus afin de réserver les capacités aux écritures critiques et de simplifier le paysage pendant le diagnostic.

Préserver les preuves avant toute correction

Les preuves comprennent identifiants, payloads filtrés, versions, réponses, traces, métriques et états source-cible. Elles sont horodatées et accessibles depuis la chronologie. Les secrets et données sensibles sont masqués ; une urgence ne justifie pas de copier des informations privées dans un canal large.

Avant de purger une file, redémarrer un worker ou modifier un mapping, l’équipe capture ce qui permet de reproduire. Une correction qui détruit le dernier message fautif peut rétablir le service mais empêcher le diagnostic et le traitement des objets déjà affectés.

Séparer preuve technique et preuve métier

La trace technique montre qu’un POST a reçu un timeout. La preuve métier indique si la commande existe réellement dans l’ERP, avec quelle référence et quel montant. Tant que cette seconde réponse manque, l’état reste ambigu et aucun retry de création n’est autorisé.

Pour la finance, une preuve relie paiement, facture et rapprochement. Pour le support, elle relie commande, statut et délai. Les vues diffèrent, mais reposent sur les mêmes identifiants afin que les équipes parlent du même objet.

Contenir la dérive sans arrêter tout le SI

Le containment vise à empêcher de nouveaux écarts tout en préservant les fonctions sûres. Il peut suspendre une route, limiter une cadence, isoler un type d’événement, couper une écriture et maintenir les lectures. Un arrêt global reste une option, pas un réflexe.

La mesure choisie doit être réversible, observable et limitée dans le temps. Elle possède un responsable, une heure de revue et un indicateur de succès. Si la file cesse de croître ou si les doublons s’arrêtent, l’équipe sait que le périmètre est correctement borné.

Le mode dégradé est préparé avec le métier. Une commande peut être acceptée puis marquée en attente, un paiement peut bloquer la livraison, ou une information peut être affichée comme temporairement indisponible. La transparence vaut mieux qu’un statut rassurant mais faux.

Reprendre par lots idempotents et contrôlés

La reprise commence par une réconciliation source-cible. Les objets déjà acceptés sont marqués comme tels ; les refus fonctionnels restent en quarantaine ; seuls les événements transitoires repartent. Cette classification empêche un rejeu massif de dupliquer des écritures ou de réintroduire une ancienne version.

Le lot pilote contient quelques objets représentatifs et utilise la même clé d’idempotence. Après validation technique et métier, la taille augmente progressivement. Le monitoring suit succès, nouveaux rejets, profondeur de file et âge du plus ancien élément jusqu’au retour au niveau normal.

Définir des critères de sortie mesurables

Sur 500 commandes en attente, le premier lot peut contenir dix objets dont deux timeouts ambigus et un statut inconnu. Le seuil exige zéro doublon, tous les états expliqués et un diagnostic inférieur à dix minutes avant de passer à cinquante puis au reste.

Si le taux d’erreur augmente au-dessus de 1 %, si une nouvelle cause apparaît ou si la réconciliation diverge, la reprise s’arrête. L’équipe revient au diagnostic avec les preuves du lot, au lieu de poursuivre parce que le calendrier promet un rétablissement rapide.

Informer chaque audience avec une vérité stable

Le premier message annonce le symptôme confirmé, le périmètre connu, la mesure de containment et l’heure du prochain point. Il sépare les faits, les hypothèses et ce qui reste à vérifier. Une estimation non fondée augmente la pression et sera répétée comme une promesse.

Le support reçoit les identifiants affectés, la réponse à donner et les actions interdites. La finance reçoit les montants et les rapprochements attendus. La direction obtient l’impact, le risque et la trajectoire. Le partenaire externe voit uniquement les éléments nécessaires à sa propre action.

Les points suivants conservent la même structure afin de rendre l’évolution lisible. Le silence est remplacé par une cadence annoncée, même lorsque l’enquête n’a pas encore produit de cause nouvelle.

Choisir retour arrière ou correction ciblée

Le retour arrière convient quand une version continue à produire de nouveaux écarts et que l’ancienne reste compatible. Il stoppe la cause technique, mais ne répare pas les objets déjà écrits. Leur correction suit une réconciliation distincte et conserve une trace.

La correction ciblée convient lorsque le logiciel est sain mais qu’un lot, un mapping ou une donnée source a dérivé. Elle limite l’impact et évite de réintroduire une ancienne version. Le choix dépend donc de la propagation, pas de la préférence de l’équipe.

Ce n’est pas seulement une décision de déploiement, c’est une décision métier. Revenir au code précédent peut modifier un contrat ou ignorer un nouveau champ obligatoire. Les propriétaires concernés valident que le chemin de repli protège encore les écritures critiques.

Mise en œuvre : tester le mode opératoire avant la panne

Le dispositif relie les entrées, sorties, responsabilités, dépendances et seuils à des commandes vérifiées. Les webhooks, files, retries, mécanismes d’idempotence, journaux et tableaux de monitoring possèdent des liens directs. L’équipe ne cherche pas l’outil au moment de l’incident.

Un exercice trimestriel simule un token OAuth expiré, une queue bloquée, un timeout après écriture et une réponse métier inconnue. Les personnes exécutent qualification, containment, communication, réconciliation et reprise avec les accès réellement disponibles.

Fermer l’exercice par des améliorations attribuées

L’observation mesure le temps avant détection, avant containment et avant reprise. Elle note les preuves introuvables, les droits manquants et les instructions ambiguës. Chaque faiblesse devient une action avec une échéance et un test de fermeture.

Le post-mortem de l’exercice vaut autant que celui d’un incident réel. Il doit rendre l’événement moins probable, moins long ou moins coûteux. Une liste sans responsable ni preuve attendue ne change pas le prochain comportement sous pression.

Cas terrain : piloter une panne fournisseur et une dérive silencieuse

Un incident visible et une dérive silencieuse n’appellent pas le même containment. Le premier menace la capacité de rattrapage ; la seconde continue à produire des écritures fausses. Les deux exemples obligent l’équipe à qualifier l’impact avant de choisir entre attente, suspension ciblée et retour à une version précédente.

Le fournisseur est indisponible pendant un pic de commandes

Les timeouts augmentent et la file dépasse sa fenêtre normale de rattrapage. La personne en charge active le mode incident, suspend les enrichissements secondaires et maintient la réception des commandes dans une queue durable. Le support reçoit un message précis sur le retard sans promettre une heure de résolution.

L’exploitation respecte le backoff et surveille l’âge du plus ancien objet au lieu de multiplier les appels. Quand le fournisseur revient, dix commandes représentatives sont réconciliées puis rejouées. Le volume augmente seulement après confirmation de l’unicité, des montants et des statuts.

La cellule garde une cadence de communication de trente minutes tant que le backlog dépasse la fenêtre de promesse. Chaque point indique le nombre d’objets reçus, repris et encore en attente. Les métiers peuvent adapter leurs réponses sans confondre reprise technique et retour complet du service client.

Le service répond mais un mapping fausse certains montants

L’incident est plus discret : les métriques HTTP sont normales, mais la finance signale des écarts après un changement de devise. Le containment bloque seulement les factures du périmètre affecté, conserve les autres flux et capture les versions de payload et de mapping utilisées depuis le dernier état sain.

Le retour arrière stoppe la nouvelle règle, puis la réconciliation identifie les objets déjà écrits. Une correction ciblée restaure les montants avec une trace comptable. Le message final distingue service disponible, dossiers réparés et exceptions encore ouvertes, afin que la clôture ne masque aucune dette résiduelle.

Le post-mortem ajoute une fixture sur la devise, un seuil d’écart financier et une validation obligatoire du mapping. La fermeture intervient lorsque ces trois protections sont testées, pas lorsque le compte rendu est publié. L’incident produit ainsi une barrière concrète contre la même dérive.

Erreurs fréquentes sous pression

Les mêmes erreurs reviennent lorsque la séquence n’a pas été exercée. Elles donnent l’impression d’agir vite, mais élargissent le périmètre ou détruisent l’information nécessaire à la reprise.

  • Redémarrer avant de préserver les preuves : capturer files, versions et exemples réels avant toute action qui efface l’état.
  • Relancer tous les objets : réconcilier la cible, classer les causes et reprendre par lots idempotents.
  • Modifier directement la base : utiliser une commande traçable, réversible et validée par le propriétaire métier.
  • Annoncer une cause trop tôt : séparer faits et hypothèses jusqu’à la reproduction ou la preuve.
  • Fermer sur une alerte verte : vérifier backlog, objets affectés et écarts source-cible avant le retour à la normale.

Le signal faible est une étape régulièrement contournée parce qu’elle semble trop lente. Il faut alors l’automatiser ou la simplifier, pas l’abandonner. Une procédure que personne ne suit n’est pas une protection.

Plan d’action pour un dispositif actionnable en quatre semaines

Le plan commence sur un seul flux critique et produit chaque semaine une preuve utilisable. L’objectif opérationnel est qu’une personne qui n’a pas écrit le connecteur puisse diagnostiquer et reprendre un incident connu.

  1. D’abord — cadrer : nommer les rôles, classifier les impacts et définir activation, containment et retour à la normale.
  2. Ensuite — relier : associer journaux, tableaux, files, commandes de repli et modèles de communication.
  3. En priorité — éprouver : injecter quatre scénarios, préserver les preuves et reprendre un lot sans accès direct aux bases.
  4. À valider — corriger : fermer les lacunes, faire exécuter la séquence par le support et confirmer les seuils avec le métier.

Décider ce qui doit attendre

À différer : les scénarios secondaires, les intégrations non critiques et les automatisations de confort tant que le flux prioritaire ne passe pas l’exercice. En priorité : les accès manquants, la corrélation, l’idempotence et la réconciliation, car ils conditionnent toutes les reprises.

À refuser : une ouverture de volume sans seuil de containment ou sans personne autorisée à l’activer. D’abord, le dispositif doit protéger le parcours existant ; ensuite seulement, il peut être généralisé à d’autres flux.

Par exemple, si le support retrouve les preuves mais ne peut pas suspendre la queue, alors l’accès de repli devient prioritaire. En revanche, une automatisation de compte rendu peut attendre. Dans ce cas, l’arbitrage protège directement la capacité de containment plutôt que le confort documentaire.

La quatrième semaine se ferme avec deux scénarios exécutés par une personne extérieure au projet et un diagnostic inférieur à dix minutes. Si une étape dépend encore d’une explication orale, alors la procédure, le lien ou le droit associé doit être corrigé avant la validation.

  • Détection : l’alerte relie le symptôme à un périmètre et à une criticité.
  • Containment : la commande ciblée arrête les nouveaux écarts sans effacer les preuves.
  • Reprise : le lot pilote est réconcilié, idempotent et validé par le métier.

Lectures complémentaires pour fiabiliser la reprise

L’observabilité API aide à construire les preuves qui alimentent le diagnostic. L’idempotence des commandes et paiements protège ensuite les retries contre les créations multiples.

La réconciliation source-cible ferme la boucle après rétablissement. Observer, décider et rapprocher doivent rester liés pour ne pas confondre service disponible et métier réellement réparé.

Conclusion : répéter sans improviser

Un runbook d’incident API transforme la pression en séquence maîtrisée. Il protège les preuves, limite les écarts et donne à chaque équipe la bonne responsabilité au moment où les décisions deviennent coûteuses.

La maturité se voit quand le containment reste ciblé, quand la communication distingue les faits et quand la reprise passe par des lots idempotents réconciliés. Le rétablissement technique n’est complet que lorsque le métier retrouve un état explicable.

Commencez par un flux critique, simulez ses échecs et mesurez le comportement réel de l’équipe. Les lacunes observées valent davantage qu’une procédure parfaite sur le papier, car elles indiquent précisément quoi renforcer avant l’incident.

Dawap peut vous accompagner pour structurer les rôles, les preuves et les exercices avec son expertise en intégration API.

Portrait de Jérémy Chomel

Transformez ce besoin en flux API fiable.

Dawap clarifie les systèmes concernés, les risques, le premier lot livrable et les conditions d’exploitation avant de construire le flux.

Vous préférez échanger ? Planifier un rendez-vous

Articles recommandés

Runbook d’incident API Intégration API Runbook d’incident API : diagnostiquer vite un flux bloqué Lire l'article
  • 9 juin 2025
  • Lecture ~55 min

Un mode opératoire d’incident API ne sert pas à documenter la panne, mais à trancher vite entre replay ciblé, correction source et isolement du flux. Quand ERP, CRM et e-commerce divergent, il réduit les faux diagnostics, protège les objets voisins et conserve la preuve qui permet au support de clôturer sans relancer une écriture déjà appliquée.

Observabilite API logs traces support finance Intégration API Observabilité API : preuves utiles au run Lire l'article
  • 20 septembre 2024
  • Lecture ~13 min

Logs, traces, métriques et preuves métier doivent expliquer incidents, reprises, paiements, commandes et écarts finance. Une observabilité utile corrèle événements, files et décisions, protège les données sensibles, fixe des seuils actionnables et donne au support comme à la finance une lecture exploitable de chaque flux critique.

Idempotence API doublons commandes paiements factures Intégration API Idempotence API : éviter les doublons Lire l'article
  • 6 août 2024
  • Lecture ~15 min

Clés d'idempotence, retries, webhooks, paiements, commandes et factures doivent être conçus ensemble pour rejouer sans doublons. L'article aide à protéger les flux où une seconde tentative peut créer une commande, un paiement, une facture ou une écriture comptable en trop au run ou côté finance interne.

Reconciliation API commandes paiements stocks compta Intégration API Réconciliation API : aligner les flux critiques Lire l'article
  • 8 août 2024
  • Lecture ~13 min

Détectez les écarts entre commandes, paiements, stocks et compta, puis corrigez les flux sans resynchronisation risquée. L'article aide à cadrer sources de vérité, tolérances, preuves, responsables et reprises pour expliquer les différences avant qu'elles ne deviennent dette finance ou support client durable.