İçeriğe geç
RemindCash

Hata yönetimi

Hata biçimi, API’nin döndürdüğü tüm durum kodları ve istek kimliklerinin kullanımı.

Herkese açık API durumu

Burada anlatılan v1 API uygulanmış ve test edilmiştir, ancak api.remindcash.com henüz herkese açık değildir. Son kabul testlerinden sonra açılacak; o zamana kadar istekler 503 döner. Örneklerde yer tutucular kullanılır — gerçek bir anahtarı asla paylaşılan koda yapıştırmayın.

Hata biçimi

Her hata aynı JSON yapısına sahiptir:

JSON
{
    "error": {
        "code": "not_found",
        "message": "Resource not found."
    },
    "request_id": "9fd120d8-f54e-4413-bc52-a860800ff222"
}

Doğrulama hataları alan başına mesajları içeren bir fields nesnesi ekler:

JSON
{
    "error": {
        "code": "validation_failed",
        "message": "Validation failed.",
        "fields": {
            "currency": ["The selected currency is invalid."],
            "due_date": ["The due date field is required."]
        }
    },
    "request_id": "89a24d53-684a-4e1d-b0ee-2f6a5a7cd2c2"
}

Hata yanıtları asla yığın izi, gizli bilgi veya başka şirketlerin verisini içermez.

Durum kodları

Durum error.code Ne zaman
401 unauthenticated API anahtarı eksik, geçersiz veya süresi dolmuş.
403 forbidden Anahtarın kapsamı yetmiyor ya da anahtar sahibi, üyelik veya şirket uygun değil.
404 not_found Kaynak yok veya başka bir şirkete ait.
409 conflict Idempotency anahtarı farklı bir gövdeyle yeniden kullanıldı, expected_version eski, external_reference tekrar ediyor veya taslak olmayan bir alacakta yalnızca taslağa özgü bir değişiklik istendi.
422 validation_failed Bir alan eksik veya geçersiz, Idempotency-Key eksik ya da durum değişikliğine izin verilmiyor.
429 rate_limited Çok fazla istek — bkz. Hız limitleri.
500 server_error Bizim tarafımızda bir sorun oluştu. Aynı Idempotency-Key ile daha sonra yeniden deneyin.

İstek kimlikleri

Her yanıt bir X-Request-Id başlığı taşır. Hata yanıtları ve okuma yanıtları bunu gövdede request_id olarak da içerir. İsteğin izlenebilmesi için destekle iletişime geçerken bunu paylaşın.

Güvenle yeniden deneme

  • 429, 500 ve ağ hatalarını bekleme süresini artırarak yeniden deneyin.
  • Yazma işlemlerinde aynı Idempotency-Key ve aynı gövdeyle yeniden deneyin; kopya yerine ilk sonucu alırsınız.
  • 4xx doğrulama veya çakışma hatalarını değiştirmeden yeniden denemeyin — önce isteği düzeltin.