Pagination et idempotency
Page à travers la liste des paramètres et de rendre chaque écriture sûre pour essayer à nouveau avec une clé d'Idempotency.
État public de l'API
L'API v1 utilise les clés porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte- porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte-porte--porte-------porte------pere-pere.
Pagination
Les paramètres de la liste (GET /v1/receivables, GET /v1/reminder-attempts) sont paginés.
| Paramètres de requête | Désignation des marchandises |
|---|---|
per_page |
Articles par page, 1–100. Défaut 25. |
page |
Numéro de page, à partir de 1. |
Chaque réponse de la liste comprend un objet meta :
{ "meta": { "current_page": 1, "per_page": 25, "total": 1 } }Continuez à demander la prochaine page jusqu'à ce que current_page × per_page atteigne total. Les créances sont commandées par id ; les tentatives de rappel sont les plus récentes en premier.
Idempotency
Chaque écriture — création, mise à jour, paiement, pause, reprise, annulation — nécessite un en-tête Idempotency-Key.
- 16 à 128 caractères : lettres, chiffres,
.,_,:ou-. - Utilisez une nouvelle clé unique par opération prévue, par exemple un UUID ou
invoice-1042-payment-1. - Les clés sont projetées à votre entreprise.
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/jsonCe qui se passe sur une répétition:
| Répéter la demande | Résultat |
|---|---|
| Même clé, même opération et même corps | La réponse originale est retournée; rien n'est créé deux fois. |
| Même clé avec un corps ou une opération différent | 409 conflict. |
| Clé manquante ou mal formée | 422 validation_failed avec une erreur de champ Idempotency-Key. |
La comparaison ignore l'ordre des touches JSON, donc {"a":1,"b":2} et {"b":2,"a":1} comptent comme le même corps.