Naar de inhoud gaan
RemindCash

Paginatie en idempotentie

Pagina door lijst eindpunten en maak elke schrijf veilig om opnieuw te proberen met een Idempotency-Key.

Openbare API-status

De v1 API maakt gebruik van company-scoped toonder keys en vereist een actieve planning periode. Ontwerp en betaling rapportage eindpunten niet verzenden klantenberichten. Voorbeelden gebruiken plaatshouders .Plakken nooit een echte sleutel in gedeelde code.

Paginatie

Lijsteindpunten (GET /v1/receivables, GET /v1/reminder-attempts) worden gepagineerd.

Zoekparameter Omschrijving
per_page Items per pagina, 1.100. Standaard 25.
page Paginanummer, te beginnen om 1.

Elke lijstrespons bevat een meta-object:

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

Blijf de volgende page aanvragen totdat current_page × per_page total bereikt. Ontvangbaren worden besteld door id; herinnering pogingen zijn de nieuwste eerst.

Idempotentie

Elke schrijf .. creëer, update, betaling, pauze, hervatten, annuleren .. vereist een Idempotency-Key header.

  • 16 tot 128 tekens: letters, cijfers, ., _, : of -.
  • Gebruik een nieuwe unieke sleutel per beoogde operatie, bijvoorbeeld een UUID of invoice-1042-payment-1.
  • De sleutels zijn van uw bedrijf.
HTTP
POST /v1/receivables/1/payments HTTP/1.1
Host: api.remindcash.com
Authorization: Bearer <your-api-key>
Idempotency-Key: payment-inv-1042-0001
Content-Type: application/json

Wat gebeurt er bij een herhaling:

Herhalingsverzoek Resultaat
Zelfde sleutel, zelfde operatie en hetzelfde lichaam De oorspronkelijke reactie wordt teruggegeven; niets wordt tweemaal gecreëerd.
Zelfde sleutel met een ander lichaam of operatie 409 conflict.
Ontbrekende of misvormde sleutel 422 validation_failed met een Idempotency-Key veldfout.

De vergelijking negeert de volgorde van JSON-toetsen, dus {"a":1,"b":2} en {"b":2,"a":1} tellen als hetzelfde lichaam.