Keamanan idempotency dan retry
Coba lagi dengan aman pembuatan tugas dokumen di seluruh batas waktu jaringan menggunakan header Idempotency-Key yang terbatas pada proyek, dan bedakan dari proses berbayar dan pengiriman penyedia.
Pembuatan tugas yang aman untuk diputar ulang#
POST /v1/tasks menerima opsional Idempotency-Key (8–128 huruf ASCII, angka, titik, garis bawah, titik dua atau tanda hubung; dimulai dengan huruf atau angka). Mengulangi kunci untuk akun HQTools dan proyek API yang sama mengembalikan tugas yang ada. Menggunakan kembali kunci yang sama untuk alat berbeda mengembalikan 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"}'ID tugas yang dikembalikan stabil di seluruh percobaan ulang. Kunci dibatasi pada akun dan proyek API serta tetap terkait dengan tugas hingga catatan yang mendasarinya dihapus. Buat kunci baru untuk tugas baru.
Aturan percobaan ulang berbeda untuk sumber daya berbeda#
Pembuatan tugas: putar ulang menggunakan Idempotency-Key yang sama setelah gangguan jaringan. Pemrosesan tugas: ID tugas tetap sudah memberikan idempotency pekerjaan/kredit backend untuk opsi identik; periksa statusnya sebelum mencoba lagi. Pekerjaan AI: gunakan kutipan yang baru disetujui pengguna dan Idempotency-Key yang stabil seperti yang didukung oleh endpoint AI. Pengiriman eSignature: respons penyedia yang tidak pasti memerlukan rekonsiliasi amplop; jangan mengirim ulang permintaan tanda tangan secara membabi buta.
Unggahan S3 yang ditandatangani menggunakan kebijakan formulir POST berumur pendek. Jangan kirim x-api-key atau Idempotency-Key ke S3. Unggahan penyimpanan dan estimasi kutipan tidak sendiri mengenakan kredit; pemrosesan melakukannya.
