Naar de inhoud gaan

Snelstart

Maak een API-toets aan en lees je eerste concept te ontvangen in een paar minuten.

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.

Deze handleiding maakt een concept te ontvangen via de API en leest het terug. Niets wordt verzonden naar uw klant.

1. Maak een API-sleutel aan

In de app, open Settings → API keys en maak een sleutel met de receivables:read en receivables:write scopes.

  • Alleen bedrijf -eigenaren en admins kan sleutels beheren.
  • Uw account heeft een geverifieerde e-mail en two-factor authenticatie nodig, en u bevestigt uw wachtwoord voordat u sleutels beheert.
  • De sleutel wordt getoond once. Kopiëren naar een geheime winkel; RemindCash houdt slechts een hash.
  • Sleutels verlopen na 30 dagen. Zie Authenticatie voor rotatie.

2. Houd de sleutel uit uw code

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

3. Maak een concept te ontvangen

Elk schrijven heeft een Idempotency-Key header nodig, zodat een opgehaald verzoek nooit een duplicaat kan maken.

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"
  }'

Het antwoord is 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. Lees het terug

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

5. Activeer in de app

Open de te ontvangen gegevens in de app, bevestig de contactgegevens en toestemming van de klant, bekijk het herinneringsschema en activeer deze. Activering is niet beschikbaar via de API.

Volgende: Concepten.