Libris Translate 0.28.0 · Guide utilisateur

Catégorie : Automatiser

Webhooks de fin de travail

Faites appeler votre serveur par Libris Translate à la fin d’une requête d’automatisation.

Parcours

  1. Un administrateur ouvre Paramètres › API d’automatisation et, dans la carte « Webhooks des requêtes d’API », liste les « Hôtes autorisés » (un par ligne, *.example.org pour les sous-domaines) et d’éventuels « Réseaux privés autorisés », puis fixe un « Secret de signature global » d’au moins 32 caractères, ou laisse chaque jeton signer avec le sien.
  2. En soumettant un travail par l’API, indiquez un callback_url situé sur l’un des hôtes autorisés.
  3. À la fin de la requête, Libris Translate envoie un seul POST signé. Vérifiez l’en-tête X-Libris-Signature, un HMAC-SHA256 de la valeur de X-Libris-Timestamp et du corps, avant de vous y fier.
  4. Récupérez ensuite l’état et le résultat de la requête par l’API. Acceptez sans dommage de recevoir deux fois la même notification, et gardez l’interrogation régulière comme solution de repli.

À savoir

Un appel en échec est retenté avec un délai croissant, jusqu’à 6 tentatives en tout et avec un délai d’attente de 10 secondes par défaut. Les adresses privées et locales sont refusées sauf si elles appartiennent à un réseau autorisé, l’adresse vérifiée est celle qui est appelée, et les redirections ne sont pas suivies. Sans hôte autorisé, les webhooks sont refusés. Le secret propre à un jeton, quand il en a un, signe toujours ses requêtes. Une notification dit que la requête est finie ; lisez son rapport pour repérer d’éventuels passages non traduits avant de publier le résultat. La référence de l’API donne les noms exacts des champs.

Exemple fictif

Un récepteur fictif vérifie la signature, enregistre l’identifiant de la requête, puis ne télécharge l’EPUB traduit que si l’état final indique que le résultat est prêt.

Continuer