Lewati ke isi
ID
Dapatkan kunci API
Jelajahi dokumentasi

Referensi API

Kesalahan dan kode status

Cari penyebab dari permintaan yang gagal dan putuskan apakah akan memperbaikinya, tunggu atau coba lagi.

Di halaman ini

HTTP kode status

Mulai dengan status HTTP, kemudian baca kode kesalahan dan pesan untuk penyebab tertentu.

StatusArtinyaYang perlu dilakukan
400Permintaan tidak validPerbaiki sumber, ruas yang diperlukan, tipe parameter atau tajuk respon sebelum mencoba kembali.
401Otentikasi gagalPeriksa X-API-Key. Ganti kunci yang kadaluwarsa atau dicabut; mencoba ulang kunci yang sama tidak akan membantu.
402Kredit tidak mencukupiPeriksa saldo rekening. Tambahkan kredit atau biarkan pemilik akun meresolf akses sebelum mengirimkan lagi.
403Akses ditolakPeriksa izin sumber kunci dan akun atau status berlangganan.
404Tidak ditemukanPeriksa URL, kerja ID dan rekening. Jobs di luar akun atau sumber yang diizinkan Anda juga dapat kembali 404.
406Tipe respon tidak dapat diterimaGunakan Accept: application/json atau text/plain. Pilih Markdown dengan X-Respond-With: markdown.
409Hasil tidak siap / konflikPada hasil yang dibaca, jajak pendapat pekerjaan yang ada sampai selesai. Untuk titik akhir lainnya, menyelesaikan konflik yang dijelaskan dalam tubuh.
410Hasil kadaluarsaGunakan salinan tersimpan. Mencoba kembali hasil URL tidak dapat mengembalikan hasil yang telah kadaluarsa.
422Pekerjaan masukan / gagal tidak validPerbaiki area laporan. Pada hasil membaca, memeriksa job.error: pekerjaan gagal tidak memiliki hasil sukses untuk mengambil.
429Batas tercapaiTunggu Retry-After atau retry_after. Kurangi laju permintaan; untuk antrian yang tertunda, tunggu tugas yang telah ada ke finish.
500 / 502 / 503 / 504Layanan atau upstream gagalCoba baca lagi dengan latar belakang yang padat. Untuk POST atau waktu pengajuan, periksa apakah pekerjaan diterima sebelum mengirimkannya lagi.

Baca sebuah respon galat

Kesalahan API menggunakan JSON, termasuk ketika Anda meminta teks biasa. Tubuh berbeda dengan titik akhir. Cabang pada HTTP status dan kode ketika ada; gunakan pesan atau detail untuk menjelaskan masalah.

Query error umumnya termasuk kesalahan dan pesan; kode adalah opsional. Galat otentikasi dapat menggunakan success: false daripada error: true.

400 · application/json
{
  "error": true,
  "code": "unsupported_representation",
  "message": "X-Respond-With supports markdown. Omit the header for the original result fields."
}

Inspeksi status, header, dan tubuh

Gunakan curl --include untuk melihat ketiganya. Contoh ini memeriksa kunci Anda dengan membaca akun gratis; ini tidak mengirimkan permintaan. Set FLASHDATA_API_KEY di lingkungan Anda terlebih dahulu.

Inspeksi respon cURL / Bash
curl --include --silent --show-error --max-time 20 \
  'https://api.flashdata.dev/v2/api-access/identity' \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Accept: application/json'

Kapan untuk mencoba lagi

POST yang berulang dapat membuat kueri yang lain. Tenggat jaringan tidak membuktikan bahwa permintaan pertama ditolak. Simpan pekerjaan ID segera setelah Anda menerimanya.

SituasiAksi berikutnya
Masukan, kunci, izin, atau keseimbangan tidak validBerhenti. Perbaiki keadaan permintaan atau akun sebelum mencoba ulang; jangan loop pada galat ini.
429 dengan petunjuk tungguKehormatan Retry-After (detik atau HTTP tanggal), atau JSON retry_after nilai dalam detik. Jika keduanya hadir, gunakan penundaan yang lebih lama.
Permintaan baca: 429 / sementara 5xx / network errorCoba GET yang sama. Tanpa petunjuk tunggu, gunakan meningkatnya penundaan dengan jitter, jumlah percobaan maksimum dan batas waktu.
POST timeout atau ambigu 5xxPertahankan pekerjaan yang ada ID dan periksa statusnya. Jika tidak ada ID yang diterima, pemeriksaan sejarah pekerjaan sebelum memutuskan untuk mengirimkan lagi.

Periksa pekerjaan latar belakang

HTTP 200 dari titik akhir status berarti membaca berhasil. Periksa job.status untuk mengetahui apakah tugas tersebut berhasil. Set JOB_ID untuk pekerjaan Anda yang ada; perintah ini tidak mengirimkan pengganti.

job.statusYang perlu dilakukan
pending / processingTunggu, lalu melakukan polling dengan pekerjaan yang sama. Hasil membaca 409 sampai selesai.
completedAmbil dan simpan hasilnya. JSON asli menghasilkan sebuah penyimpanan 302 direk; hasil terformat mengembalikan tubuh secara langsung.
failedBerhenti polling dan periksa job.error. Hasil akhir mengembalikan 422 dengan kode result_not_ready untuk pekerjaan yang gagal.
Baca status pekerjaan cURL / Bash
curl --fail-with-body --silent --show-error --max-time 30 \
  "https://api.flashdata.dev/v2/jobs/${JOB_ID:?Set JOB_ID}" \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Accept: application/json'

Kesalahan format responsa-

Status / kodePerbaiki
400 · unsupported_representationSet X-Respond-With ke markdown, atau hapus header.
406 · not_acceptableSet Accept ke application/json atau text/plain; gunakan UTF-8 jika menyatakan charset.

Dapatkan bantuan dengan permintaan

Kirim titik akhir, penanda waktu UTC, status HTTP, kode kesalahan dan permintaan atau pekerjaan ID. Hapus kunci API, token, dan ditandatangani URLs dari laporan.