İçeriğe geç
RemindCash

Sayfalama ve idempotency

Liste uç noktalarında sayfalar arasında gezinin ve her yazma işlemini Idempotency-Key ile güvenle yeniden denenebilir yapın.

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.

Sayfalama

Liste uç noktaları (GET /v1/receivables, GET /v1/reminder-attempts) sayfalanır.

Sorgu parametresi Açıklama
per_page Sayfa başına öğe, 1–100. Varsayılan 25.
page 1’den başlayan sayfa numarası.

Her liste yanıtı bir meta nesnesi içerir:

JSON
{ "meta": { "current_page": 1, "per_page": 25, "total": 1 } }

current_page × per_page değeri total’a ulaşana kadar sonraki page değerini isteyin. Alacaklar id’ye göre, hatırlatma denemeleri en yeniden eskiye sıralanır.

Idempotency

Her yazma işlemi — oluşturma, güncelleme, ödeme, duraklatma, sürdürme, iptal — bir Idempotency-Key başlığı gerektirir.

  • 16 ile 128 karakter arası: harf, rakam, ., _, : veya -.
  • Amaçlanan her işlem için yeni ve benzersiz bir anahtar kullanın, örneğin bir UUID veya invoice-1042-payment-1.
  • Anahtarlar şirketinizle sınırlıdır.
HTTP
POST /v1/receivables/1/payments HTTP/1.1
Host: api.remindcash.com
Authorization: Bearer <api-anahtariniz>
Idempotency-Key: payment-inv-1042-0001
Content-Type: application/json

Tekrarlanan bir istekte ne olur:

Tekrarlanan istek Sonuç
Aynı anahtar, aynı işlem ve aynı gövde İlk yanıt döndürülür; hiçbir şey iki kez oluşturulmaz.
Aynı anahtar, farklı gövde veya işlem 409 conflict.
Eksik veya hatalı biçimli anahtar Idempotency-Key alan hatasıyla 422 validation_failed.

Karşılaştırma JSON anahtarlarının sırasını dikkate almaz; {"a":1,"b":2} ile {"b":2,"a":1} aynı gövde sayılır.