Pagination und Idempotenz
Seiten Sie durch Listenendpunkte und machen Sie jedes Schreiben sicher, um es mit einem Idempotency-Key erneut zu versuchen.
Public API Status
Die v1-API verwendet unternehmensweit erfasste Trägerschlüssel und erfordert einen aktiven Planzeitraum. Endpunkte für Entwurfs- und Zahlungsberichte senden keine Kundennachrichten. Beispiele verwenden Platzhalter — fügen Sie niemals einen echten Schlüssel in einen freigegebenen Code ein.
Pagination
Listen-Endpunkte (GET /v1/receivables, GET /v1/reminder-attempts) werden paginiert.
| Abfrageparameter | Beschreibung |
|---|---|
per_page |
Artikel pro Seite, 1–100. |
page |
Seitenzahl, beginnend bei 1. |
Jede Listenantwort enthält ein meta-Objekt:
{ "meta": { "current_page": 1, "per_page": 25, "total": 1 } }Bitten Sie weiter um das nächste page bis current_page × per_page Reichweite totalForderungen werden bestellt von idErinnerungsversuche sind zuerst neu.
Idempotenz
Jedes Schreiben - Erstellen, Aktualisieren, Bezahlen, Pausen, Lebenslauf, Stornieren - erfordert einen Idempotency-Key-Header.
- 16 bis 128 Zeichen: Buchstaben, Ziffern,
.,_,:oder-. - Verwenden Sie einen neuen eindeutigen Schlüssel pro beabsichtigter Operation, z. B. eine UUID oder
invoice-1042-payment-1. - Die Schlüssel sind auf Ihr Unternehmen ausgerichtet.
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/jsonWas passiert bei einer Wiederholung:
| Wiederholungsanforderung | Ergebnis |
|---|---|
| Der gleiche Schlüssel, die gleiche Operation und derselbe Körper | Die ursprüngliche Antwort wird zurückgegeben; nichts wird zweimal erstellt. |
| Derselbe Schlüssel mit einem anderen Körper oder einer anderen Operation | 409 conflict. |
| Fehlender oder fehlerhafter Schlüssel | 422 validation_failed mit einem Idempotency-Key-Feldfehler. |
Der Vergleich ignoriert die Reihenfolge der JSON-Schlüssel, so dass {"a":1,"b":2} und {"b":2,"a":1} als derselbe Körper zählen.