Belgeleri incele
API başvurusu
Başarısız bir talebin nedenini bulun ve onu düzeltmeye karar verin, bekleyin veya yeniden deneme.
Bu sayfada
HTTP statüsü kodları
HTTP statüsü ile başlayın, sonra belirli sebep için hata kodu ve mesajı okuyun.
| Durum durumu | Anlam Anlamı | Yapılacak işlem |
|---|---|---|
| 400 | Invalid isteği | Kaynağı düzeltin, gerekli alanları, parametre türleri veya yanıt başlıkları yeniden denemeden önce. |
| 401 | Kimlik doğrulama başarısız oldu | X-API-Key'u kontrol edin. Geç bir anahtar değiştirmek veya geri çekilmek; aynı anahtarı tekrarlamak yardımcı olmayacaktır. |
| 402 | Yetersiz kredilerde | Hesap bakiyesini kontrol edin. Kredi ekleyin veya hesap sahibinin tekrar göndermeden önce erişimi çözmesine izin verin. |
| 403 | Erişim inkarı reddedildi | Anahtarın kaynak izinlerini ve hesabı veya abonelik durumunu kontrol edin. |
| 404 | bulunamadı | URL, iş ID ve hesabı kontrol edin. İzin verilen hesabınızın veya kaynaklarının dışındaki işler de 404'yu geri döndürebilir. |
| 406 | Yanıt türü kabul edilemez | Accept: application/json veya text/plain. Markdown ile X-Respond-With: işaret. |
| 409 | Hazır değil / çatışma | Sonuç olarak, mevcut işi tam olana kadar anket yapın. Diğer uç noktaları için, vücutta açıklanan çatışmayı çöz. |
| 410 | Sonuç süresi sona ermişti | Kurtarılan bir kopyasını kullanın. Sonuç URL, sona ermiş bir sonucu geri getiremez. |
| 422 | Invalid girişi / başarısız iş | Raporlanan alanları düzeltin. Sonuç olarak, job.error: başarısız bir iş getirmenin başarılı bir sonucu yoktur. |
| 429 | Limit ulaştı | Retry-After veya retry_after için bekleyin. Talep oranını azaltır; tam bir bekleme süresi için, mevcut işleri finish'ya bekleyin. |
| 500 / 502 / 503 / 504 | Hizmet veya upstream başarısızlık başarısızlık | Retry, sınırlanmış gerile okur. Bir POST veya teslim süresi için, tekrar göndermeden önce iş kabul edilip kabul edilip alın. |
Bir hata yanıtını okuyun
API hataları JSON'u standart metin talep ettiğinizde kullanır. Vücut uç nokta ile farklıdır. HTTP statüsü ve kodu mevcut olduğunda; sorunu açıklamak için mesaj veya detay kullanın.
Sorgu hataları genellikle hata ve mesaj içerir; kod isteğe bağlıdır. Kimlik hataları success: false yerine error: true kullanabilir.
{
"error": true,
"code": "unsupported_representation",
"message": "X-Respond-With supports markdown. Omit the header for the original result fields."
}V2 problem yanıtları application/problem+json'u kullanır. requestId'u destek için tut. Geçerlilik hataları da fieldErrors'u alan, kod ve mesajla içerebilir.
{
"type": "https://api.flashdata.dev/problems/invalid_api_key",
"title": "Invalid API Key",
"status": 401,
"code": "invalid_api_key",
"requestId": "example-request-id",
"detail": "The API Key is invalid or unavailable."
}Inspect durumu, Başlıklar ve Vücut
curl --include'u tüm üçünü görmek için kullanın. Bu örnek, anahtarınızı ücretsiz bir hesap okuma ile kontrol eder; bir sorgu göndermez. FLASHDATA_API_KEY'u ilk önce çevrenizde ayarlayın.
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'Yeniden deneme ne zaman
Tekrarlanan POST başka bir ücretli sorgu oluşturabilir. Ağ zaman aşımı ilk isteğin reddedildiğini kanıtlamaz. İş ID değerini alır almaz kaydedin.
| Durum durumu | Sonraki eylem |
|---|---|
| Invalid girişi, anahtar, izin veya denge | Dur. İstek veya hesap durumunu yeniden denemeden önce düzeltin; bu hatalarda döngüsüz. |
| 429 bir bekleme ipucu ile | Honor Retry-After (saniyeler veya HTTP tarihi), veya JSON retry_after değeri saniyede. Her ikisi de mevcutsa, daha uzun gecikme kullanın. |
| Talep: 429 / geçici 5xx / ağ hatası | Aynı GET’yu yeniden deneyin. Beklenmeyen bir ipucu olmadan, jitter ile artan gecikmeleri kullanın, maksimum bir deneme hesabı ve zaman sınırı. |
| POST zamanout veya belirsiz 5xx | Mevcut iş ID'u tut ve statüsünü kontrol edin. Eğer ID alınsaydı, tekrar göndermeye karar vermeden önce iş tarihini kontrol edin. |
Bir arka plan işi kontrol edin
HTTP 200 statü uç noktasından okuma başarılı olduğu anlamına gelir. Görevin başarılı olup olmadığını bilmek için job.status'u kontrol edin. JOB_ID'u mevcut işinize ayarlayın; bu komut bir yedek göndermez.
| job.status | Yapılacak işlem |
|---|---|
| pending / processing | Bekle, sonra aynı işi anket yapın. Sonuç olarak, 409'u tamamlanmaya kadar döndürür. |
| completed | Erişim ve sonucu kurtarmak. Orijinal JSON sonuçları bir 302 depolama yönlendirmesini döndürür; formatlı sonuçlar doğrudan bir vücut döndürür. |
| failed | job.error'u ankete bırakın. Sonuç uç noktası 422'u başarısız bir iş için kod result_not_ready ile döndürür. |
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'Yanıt-format hataları
| Durum / kod | Fix Fix |
|---|---|
| 400 · unsupported_representation | X-Respond-With'u işaret etmek veya başlığı kaldırmak için ayarlayın. |
| 406 · not_acceptable | Accept'u application/json veya text/plain'ye ayarlayın; bir karset belirtse UTF-8'u kullanın. |
Bir istekle yardım alın
Son noktayı gönderin, UTC timestamp, HTTP statüsü, hata kodu ve talep veya iş ID. API anahtarlarını, jetonları ve rapordan URLs'u imzaladı.