Hata modeli
RFC 9457 hata gövdesi, hata kodları ve hangisinin yeniden denenebileceği.
Geliştirici belgesi
Her hata yanıtı application/problem+json içerik türüyle RFC 9457 biçimindedir. İstemciniz title, detail ya da message metnine değil, code alanına göre dallanmalıdır: metinler değişebilir, kodlar değişmez. Metinler Türkçedir.
{
"type": "urn:biik:api:v1:problem:validation_failed",
"title": "Girdi doğrulanamadı",
"status": 400,
"code": "validation_failed",
"request_id": "5b0d3c9e-2f4a-4e61-9a7b-8c1d2e3f4a5b",
"errors": [
{ "field": "body.nickname", "code": "unrecognized_keys", "message": "Tanınmayan alan" }
]
}
Alanlar
type: hata türünün kararlı URN'i,urn:biik:api:v1:problem:<code>.title: insan için kısa başlık.status: HTTP durum kodu.code: makine için hata kodu.request_id: isteğin kimliği. Destek talebinde bu değeri verin.detail: varsa insan için ayrıntı.errors: yalnızvalidation_failedyanıtında, alan düzeyi hatalar (field,code,message).
Hata kodları
| code | HTTP | Açıklama |
|---|---|---|
bad_ | 400 | Geçersiz istek |
validation_ | 400 | Girdi doğrulanamadı |
key_ | 400 | Anahtar sorgu dizesinde gönderilemez |
cookie_ | 400 | Anahtar çerezle birlikte gönderilemez |
idempotency_ | 400 | Idempotency-Key başlığı gerekli |
idempotency_ | 400 | Idempotency-Key başlığı geçersiz |
cursor_ | 400 | İmleç geçersiz ya da bu sorguya ait değil |
unauthorized | 401 | Kimlik doğrulanamadı |
insufficient_ | 403 | Anahtarın kapsamı bu işleme yetmiyor |
forbidden | 403 | Anahtarın rolü bu işleme izin vermiyor |
module_ | 403 | Modül bu hesapta kapalı |
trial_ | 403 | Deneme süresi bitti, hesap salt okunur |
key_ | 403 | Anahtar askıda: rolü ya da bağlaması geçersiz |
not_ | 404 | Kayıt bulunamadı |
method_ | 405 | Yöntem desteklenmiyor |
idempotency_ | 409 | Aynı Idempotency-Key ile süren bir istek var |
conflict | 409 | İstek kaydın bugünkü durumuyla çakışıyor |
payload_ | 413 | Gövde çok büyük |
unsupported_ | 415 | İçerik türü desteklenmiyor |
idempotency_ | 422 | Idempotency-Key başka bir istekle kullanılmış |
rate_ | 429 | İstek sınırı aşıldı |
internal_ | 500 | Beklenmeyen hata |
timeout | 503 | İstek süre sınırını aştı |
Yeni bir hata kodu eklenebilir; var olan bir kodun durumu ve anlamı değişmez. Tanımadığınız bir kodu HTTP durumuna göre ele alın.
Ne zaman yeniden denenir
429 rate_limited:Retry-Afterbaşlığındaki saniye kadar bekleyip yineleyin (Hız sınırı).503 timeout: istek süre sınırını aştı ve geri alındı.Retry-Afterkadar bekleyip yineleyin; liste isteğinde süzgeci daraltmak ya da sayfa boyutunu küçültmek yardımcı olur.409 conflict: eşzamanlı bir yazımla çakıştı.Retry-Afterbaşlığı varsa bekleyip yineleyin; yoksa kaydın güncel hâlini okuyun (örneğin iş e-postası başka bir etkin çalışanda kullanılıyor).409 idempotency_in_progress: aynıIdempotency-Keyile gönderilen istek hâlâ sürüyor. Biraz bekleyip aynı anahtarla yineleyin.500 internal_error:POSTisteğini aynıIdempotency-Keyile yinelemek güvenlidir.4xxhataların geri kalanı isteğin kendisindedir; aynı isteği değiştirmeden yinelemek aynı yanıtı verir.