API

Beschikbaar

Een REST-API met een OpenAPI-beschrijving, ondertekende webhooks, een testmodus die de hele keten doorloopt, en clients voor Node en Python.

Wat je ermee kunt

POST /api/v1/letters met tekst, een PDF in base64 of een URL naar een PDF.
Webhooks op submitted, printed, posted, delivered, failed en refunded.
Testsleutels doorlopen alles inclusief webhooks, zonder te drukken of af te schrijven.

Maak onder Account > Ontwikkelaars een testsleutel aan die begint met sk_test_. Geef alleen de rechten die je toepassing nodig heeft.
Gebruik POST /api/v1/letters/prepare met tekst of een PDF, beide adressen en een vaste idempotencyKey. Dit rendert het document en geeft de exacte totaalprijs terug zonder verzending.
Bekijk de PDF via GET /api/v1/letters/{id}/pdf en laat document en totalCents goedkeuren. Roep daarna POST /api/v1/letters aan met dezelfde invoer en sleutel en expectedTotalCents.
Node en Python ondersteunen prepare en prijsbevestiging vanaf versie 1.2.0. Installeer met npm install sendletter of pip install --upgrade sendletter.
Herhaal met dezelfde sleutel na een time-out. Volg de brief met GET /api/v1/letters/{id} of ondertekende webhooks. Gebruik pas een livesleutel nadat de volledige testketen klopt.