Idempotence et sécurité des tentatives
Réessayez en toute sécurité la création de tâche de document sur les délais d'expiration du réseau en utilisant les en-têtes Idempotency-Key limités au projet, et distinguez-les de la distribution de processus payants et de fournisseurs.
Création de tâche sûre pour la relecture#
POST /v1/tasks accepte un paramètre optionnel Idempotency-Key (8–128 caractères ASCII : lettres, chiffres, points, traits de soulignement, deux-points ou tirets ; commence par une lettre ou un chiffre). La répétition d'une clé pour le même compte HQTools et projet API retourne la tâche existante. La réutilisation de la même clé pour un outil différent retourne 409 IDEMPOTENCY_KEY_REUSED.
curl -q --fail-with-body -X POST 'https://api.pdfhq.io/v1/tasks' \
-H 'x-api-key: YOUR_SERVER_SIDE_API_KEY' \
-H 'Idempotency-Key: job-20261025-00001' \
-H 'Content-Type: application/json' \
-d '{"tool":"compress"}'L'ID de tâche retourné est stable lors des nouvelles tentatives. Les clés sont limitées à un compte et un projet API et restent associées à la tâche jusqu'à ce que l'enregistrement sous-jacent soit supprimé. Créez une nouvelle clé pour une nouvelle tâche.
Règles de nouvelle tentative différentes pour différentes ressources#
Création de tâche : relancer en utilisant la même Idempotency-Key après une interruption réseau. Traitement des tâches : l'ID de tâche fixe fournit déjà l'idempotence du travail/crédit backend pour les options identiques ; inspectez son état avant de réessayer. Tâches IA : utiliser une citation approuvée par l'utilisateur et une Idempotency-Key stable comme supporté par le point de terminaison d'IA. Envoi de signature électronique : une réponse incertaine du fournisseur nécessite une réconciliation d'enveloppe ; ne renvoyez pas aveuglément une demande de signature.
Les téléchargements S3 signés utilisent des politiques de formulaire POST à courte durée de vie. N'envoyez pas x-api-key ou Idempotency-Key vers S3. Les importations de stockage et l'estimation de devis ne facturent pas eux-mêmes de crédits ; le traitement le fait.
