Bonnes pratiques et dépannage
Bonnes pratiques et dépannage
Fiabilisez vos exports et envois : stratégie, logs, tests et résolution des erreurs courantes
Conseils pratiques pour assurer des exports fiables côté client, des envois sécurisés vers vos destinations et une résolution rapide des incidents.
Ce que couvre cette page
Export côté client
Rappel : la génération finale et le téléchargement du fichier se font dans le navigateur. On couvre les vérifications à effectuer côté client avant et après génération.
Envoi vers des destinations
Comment préparer les destinations (auth, headers, payload_template), surveiller les envois et tirer parti des stratégies de retry configurées.
Prévisualisation et tests
Configurer des filtres, prévisualiser résultats, faire des tests de charge et valider les payloads avant publication.
Journaux et diagnostics
Que regarder dans les logs, comment reproduire et collecter les traces nécessaires pour résoudre incidents (timeouts, erreurs d’auth, fichiers volumineux).
Stratégies de retry
Quand et comment appliquer retries progressifs, backoff exponentiel, et limites pour éviter surcharges et duplication.
Sécurité des destinations
Meilleures pratiques pour sécuriser clés, signer payloads, restreindre IPs et vérifier certificats TLS.
À propos de ce guide
Ce guide est un complément pratique à l’interface : il vous explique quoi vérifier et quelles actions effectuer dans l’interface Export / Envoyer / Prévisualiser pour réduire les erreurs et accélérer le dépannage.
Flux : Exporter un document (Markdown / JSON) — pas à pas
Étape 1 — Ouvrir le document
Accédez au document que vous souhaitez exporter depuis la liste ou l’éditeur et ouvrez la vue détaillée.
Étape 2 — Choisir le format
Cliquez sur “Export Markdown” ou “Export JSON” selon le format désiré. Vérifiez que le contenu affiché correspond bien à ce que vous attendez (titres, sections, métadonnées).
Étape 3 — Pré-vérifications côté client
Avant de lancer l’export, contrôlez : la langue, le rendu des images, la présence de champs obligatoires et la taille estimée. Si le document contient images ou pièces jointes volumineuses, notez leur taille.
Étape 4 — Lancer l'export
Cliquez sur le bouton d’export. Le fichier est généré côté navigateur et le navigateur déclenche le téléchargement. Attendez la notification de succès ou l’apparition d’une erreur.
Étape 5 — Vérifier le fichier téléchargé
Ouvrez le fichier téléchargé pour vérifier l’encodage, la complétude et l’absence de caractères tronqués. Si JSON, validez la structure ; si Markdown, vérifiez les liens et images.
Étape 6 — En cas d'échec
Si le téléchargement ne démarre pas : essayez d’actualiser la page, testez avec un autre navigateur, ou réduisez la taille du document (supprimez images temporaires) et recommencez. Consultez les logs de l’interface pour tout message d’erreur.
Astuce export
Pour les documents volumineux, divisez l’export en sections (chapitres) ou limitez d’abord aux métadonnées essentielles puis exportez les médias séparément. Cela réduit les risques de dépassement de mémoire côté navigateur.
Flux : Envoyer un document vers une destination (Send) — pas à pas
Étape 1 — Choisir la destination
Dans la boîte de dialogue d’envoi, sélectionnez la destination souhaitée dans la liste (webhook, service tiers, e‑mail). Vérifiez que la destination active possède les bonnes informations d’authentification et d’en-têtes.
Étape 2 — Vérifier la configuration d'authent
Contrôlez le mode d’authentification configuré (clé, Basic, Bearer, signature). Assurez-vous que la clé/token est valide, non expiré, et a les droits nécessaires chez le destinataire.
Étape 3 — Inspecter le template du payload
Vérifiez le modèle de payload (payload_template) : champs requis, format JSON/URL-encoded, et champs de signature. Préparez un exemple concret pour la destination.
Étape 4 — Lancer l'envoi
Cliquez sur “Send”. L’interface affichera le statut de l’envoi (succès / erreur). Notez le code de réponse et le message d’erreur éventuel.
Étape 5 — Suivre les retries
Si l’envoi échoue mais que la destination est configurée avec des retries, attendez et suivez le journal des tentatives. Les retries respectent la politique définie (nombre, intervalle).
Étape 6 — Confirmer la réception
Vérifiez côté destinataire que le payload a bien été reçu et traité. Comparez le payload réel avec le template attendu et corrigez les différences.
Étape 7 — En cas d'erreur persistante
Collectez le log d’envoi (code HTTP, body de réponse, timestamp, durée). Testez manuellement le payload avec l’outil de destination (console de webhook, simulateur) et ajustez l’auth ou les headers.
Meilleure pratique pour les envois
Activez toujours un en-tête “Idempotency-Key” ou équivalent si votre destination le supporte. Cela réduit les risques de duplication lors de retries automatiques.
Attention — duplication et effets secondaires
Si votre destination exécute des actions (création de ressources, envois d’e-mails), ne laissez pas de retries illimités sans idempotence : une même requête reroutée plusieurs fois peut produire des effets indésirables.
Flux : Prévisualiser des documents (Preview documents) — pas à pas
Étape 1 — Configurer les filtres
Ouvrez la fenêtre de prévisualisation, définissez les filtres (dates, agents, branches, tags) pour restreindre l’ensemble à un échantillon représentatif.
Étape 2 — Lancer la prévisualisation
Cliquez sur “Preview documents”. L’outil retournera un exemple de documents correspondant aux filtres : inspectez plusieurs éléments pour vérifier la consistance.
Étape 3 — Valider le payload final
Pour chaque document aperçu, examinez le payload tel qu’il serait envoyé : structure, champs manquants, encodage, contenu HTML/Markdown.
Étape 4 — Itérer sur le template
Si des champs manquent ou sont mal formatés, modifiez le template de payload puis relancez la prévisualisation jusqu’à obtention d’un résultat conforme.
Étape 5 — Test de bout en bout
Avant mise en production, effectuez un envoi de test vers une destination de staging pour vérifier l’intégration complète (auth, headers, parsing côté destinataire).
Conseil de test
Utilisez une destination de type “echo” ou un outil de capture (webhook tester) pour recevoir et inspecter le payload exact envoyé. Cela évite d’affecter des environnements de production pendant les tests.
Stratégies de fiabilisation et retries
- Nombre fixe de tentatives (ex. 3).
- Intervalle constant entre tentatives (ex. 10 s).
- Simple à comprendre et à implémenter.
- Risque : en cas de surcharge du destinataire, les tentatives synchrones peuvent aggraver la situation.
Déployer une stratégie de retry efficace — étapes recommandées
Étape 1 — Catégoriser les erreurs
Séparez les erreurs transitoires (timeout, 5xx, rate limit) des erreurs permanentes (401, 403, 400, validation). Appliquez retries seulement aux erreurs transitoires.
Étape 2 — Choisir un backoff adapté
Privilégiez un backoff exponentiel avec jitter pour la plupart des destinations publiques. Définissez un nombre maximal d’essais et un délai total maximal.
Étape 3 — Ajouter de l'idempotence
Lorsqu’une action peut être reprise, utilisez une clé idempotente unique pour éviter les duplications côté destinataire.
Étape 4 — Monitoring et alertes
Configurez des alertes pour les échecs répétés et un tableau de bord des taux d’erreur par destination.
Étape 5 — Tests en charge
Simulez des latences et interruptions côté destinataire pour valider que la stratégie de retry ne provoque pas de sursaut de trafic.
Avant : payloads fortement couplés et tests manuels.
- Modèles rigides, champ manquant => échec.
- Tests en prod risqués.
Après : payloads robustes et tests reproductibles.
- Modèle tolérant aux champs optionnels.
- Prévisualisation et destinataires de test.
- Retries maîtrisés et idempotence.
Template de payload robuste
- Inclure des champs obligatoires et documenter les champs optionnels.
- Normaliser les formats (dates ISO, identifiants, URLs).
- Prévoir des champs de métadonnées (trace_id, timestamp, source) pour faciliter le traçage.
- Valider le payload sur un destinataire de staging avant production.
Journaux, monitoring et collecte d’informations
Que collecter en cas d'incident — checklist
Étape 1 — Rassembler les métadonnées de l'envoi
Horodatage, identifiant du document, destinataire choisi, taille du payload, template utilisé.
Étape 2 — Noter les erreurs retournées
Code HTTP, en-têtes de réponse, body de réponse (message d’erreur), latence mesurée.
Étape 3 — Capturer les traces côté client
Si l’export est côté client, récupérer la console du navigateur et l’instantané du téléchargement (erreurs JS, out-of-memory).
Étape 4 — Vérifier les tentatives de retry
Combien de tentatives ont été effectuées et à quels horaires — cela montre si les retries ont aidé ou aggravé.
Étape 5 — Test reproduisible
Reproduisez l’envoi avec le même payload vers un destinataire de test pour observer le comportement sans impacter la prod.
Conserver les logs sensibles en sécurité
Les logs peuvent contenir des tokens, clés ou données personnelles. Restreignez l’accès, masquez ou hachez les secrets avant de les partager lors d’un dépannage.
Résolution des problèmes fréquents
Timeouts et latences — démarche de dépannage
Étape 1 — Confirmer le timeout
Vérifiez si l’erreur indiquait un timeout côté client ou une réponse longue du destinataire. Notez la durée avant l’échec.
Étape 2 — Tester la latence réseau
Effectuez un envoi vers la destination depuis un réseau proche (ou outil de test) pour mesurer RTT et variation.
Étape 3 — Réduire le payload
Si possible, testez avec une version allégée du payload (sans pièces jointes/media) pour voir si le problème vient du transfert.
Étape 4 — Ajuster la stratégie de retry
Augmentez légèrement le timeout et utilisez backoff exponentiel si l’origine est temporaire.
Étape 5 — Contacter le destinataire
Si la latence persiste, demandez au destinataire s’il y a des limites de débit, maintenance ou problèmes internes.
Échecs d'authentification — démarche de dépannage
Étape 1 — Vérifier les identifiants
Assurez-vous que la clé/token n’a pas expiré ni été révoqué et qu’il correspond au type d’auth attendu (Bearer, Basic, signature).
Étape 2 — Valider le format des headers
Contrôlez l’en-tête Authorization et autres headers requis ; certains services exigent un préfixe exact ou un header personnalisé.
Étape 3 — Reproduire avec l'outil du destinataire
Utilisez l’interface de test du destinataire (ou un outil de requête) pour vérifier que les mêmes informations d’auth fonctionnent.
Étape 4 — Examiner la réponse
Si la réponse contient un message précis (ex. “token invalid”, “signature mismatch”), ajustez la méthode d’auth ou la signature.
Étape 5 — Renouvellement sécurisé des clés
Si nécessaire, régénérez les clés dans un environnement sécurisé et mettez à jour la destination en suivant la procédure d’activation recommandée.
Fichiers trop volumineux — démarches et options
Étape 1 — Estimer la taille
Avant export/envoi, vérifiez la taille totale des médias et du document. Beaucoup de navigateurs ont des limites et certains destinataires aussi.
Étape 2 — Fractionner ou externaliser
Fractionnez en plusieurs exports ou hébergez les fichiers volumineux (stockage objet) et envoyez des liens dans le payload au lieu d’inclure les binaires.
Étape 3 — Compression
Compressez images et médias (optimisation d’images, minification) pour réduire la charge réseau.
Étape 4 — Tester la résilience
Simulez l’envoi des fichiers volumineux vers l’environnement de staging pour vérifier le comportement et la reprise après échec.
Étape 5 — Politique de retry et quotas
Évitez les retries agressifs sur gros transferts : définissez des règles pour ne pas répéter les uploads complet sans reprise (ou support de reprise côté destinataire).
Questions fréquentes — Bonnes pratiques et dépannage
Conseil pour les tickets de support
Fournissez toujours un envoi d’exemple complet (payload) et un log de la dernière tentative : cela accélère grandement le diagnostic côté support.
Automatiser les vérifications
Ajoutez des préchecks automatisés (taille max, présence des champs obligatoires, format ISO date) avant chaque envoi pour éviter erreurs simples et répétitives.
Ne pas exposer de secrets dans les previews
Les prévisualisations et les logs de test doivent masquer ou remplacer les clés et tokens. Évitez d’inclure des secrets bruts dans les captures ou tickets.
Prêt à sécuriser vos exports et envois ?
Avant toute publication, effectuez une prévisualisation et envoyez un test vers une destination de staging pour valider l’ensemble du flux.