Passer au contenu

Démarrage rapide

Créez une clé API, puis créez et lisez votre premier projet de réception en quelques minutes.

É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.

Ce guide crée un projet de réception par l'intermédiaire de l'API et le lit en arrière. Rien n'est envoyé à votre client.

1. Créer une clé API

Dans l'application, ouvrez Paramètres → touches API et créez une clé avec les champs receivables:read et receivables:write.

  • Seule la société ** propriétaires et administrateurs** peut gérer les clés.
  • Votre compte a besoin d'un e-mail vérifié et d'une authentification deux facteurs, et vous confirmez votre mot de passe avant de gérer les clés.
  • La clé est affichée once. Copiez-la dans un magasin secret; RemindCash ne conserve qu'un hash.
  • Les touches expirent après 30 jours. Voir Authentification pour la rotation.

2. Gardez la clé hors de votre code

BASH
export REMINDCASH_API_KEY="<your-api-key>"

3. Créer un projet de créance

Chaque écriture a besoin d'un en-tête Idempotency-Key afin qu'une requête retriée ne puisse jamais créer de duplicata.

BASH
curl https://api.remindcash.com/v1/receivables \
  --request POST \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: create-inv-1042-0001" \
  --header "Content-Type: application/json" \
  --data '{
    "customer": { "display_name": "Studio North", "email": "billing@studionorth.example" },
    "amount": "1250.00",
    "currency": "USD",
    "due_date": "2026-10-15",
    "external_reference": "INV-1042",
    "description": "Website redesign"
  }'

La réponse est 201 Created:

JSON
{
    "data": {
        "id": 1,
        "customer_id": 1,
        "amount_minor": 125000,
        "paid_minor": 0,
        "currency": "USD",
        "due_date": "2026-10-15",
        "status": "draft",
        "external_reference": "INV-1042",
        "description": "Website redesign",
        "version": "4e6fea39ae2fab8ccb843657f081d276513739a71787c060a007b65e3acbbbc1"
    }
}

4. Relisez-le

BASH
curl https://api.remindcash.com/v1/receivables/1 \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"

5. Activer dans l'application

Ouvrez la créance dans l'application, confirmez les coordonnées et l'autorisation du client, examinez l'horaire de rappel et activez-la. L'activation n'est pas disponible via l'API.

Suivant : Concepts.