Lever post programmatisch aan bij Plof. Je hebt een API-sleutel nodig — die maak je aan in je verzendportaal onder “API & developers”. Bouw je de koppeling namens een bedrijf? Dan nodigt dat bedrijf je uit als medewerker met het recht “API & developers”; zo krijg je toegang tot de sleutels zonder inzage in hun post.
Elk verzoek stuurt je API-sleutel mee in de header X-Plof-Key (of als Authorization: Bearer …). De sleutel hoort bij één verzender; Plof bewaart alleen een hash. Verlies je hem, maak dan een nieuwe aan en trek de oude in.
POST https://plof.app/wp-json/plof/v1/stukken
Stuur het bezorgadres en de PDF (als base64, of als multipart-bestand). Plof matcht het adres tegen het ankerregister en bezorgt digitaal, of zet het stuk op retour als de ontvanger niet bereikbaar is.
POST https://plof.app/wp-json/plof/v1/stukken/batch
Lever tot 5000 stukken per verzoek aan. De stukken worden versleuteld opgeslagen en op de achtergrond bezorgd — je krijgt meteen antwoord en volgt de voortgang als één verzending in het portaal. Geef optioneel een label mee zodat je de verzending herkent.
De HTTP-status is 207 (Multi-Status): sommige stukken kunnen slagen terwijl andere falen. Controleer per stuk het veld ok in resultaten.
GET https://plof.app/wp-json/plof/v1/stukken/{stuk_id}
Vraag de actuele status op van een stuk dat je eerder aanleverde. Je ziet alleen je eigen stukken.
Mogelijke statussen: nieuw, bezig, bezorgd, geopend, wacht_op_anker (ontvanger gebruikt Plof nog niet), retour, verwijderd.
| Veld | Verplicht | Omschrijving |
|---|---|---|
adres_pc | ja | Postcode van de ontvanger, bv. 1234AB. |
adres_nr | ja | Huisnummer. |
adres_toev | nee | Toevoeging (bv. A, bis). |
pdf_base64 | ja* | De PDF als base64. *Of lever de PDF als multipart-bestand mee. |
idempotency_key | aanbevolen | Eigen unieke sleutel; voorkomt dubbele bezorging bij opnieuw versturen. |
type | nee | gewoon (standaard) of aangetekend. |
label | nee | Alleen bij batch: naam van de verzending. |
| HTTP | Betekenis | Wat te doen |
|---|---|---|
401 | API-sleutel ontbreekt | Voeg de header X-Plof-Key toe. |
403 | Ongeldige of ingetrokken sleutel | Controleer de sleutel of maak een nieuwe aan in het portaal. |
400 | Verzoek onvolledig | Adres of PDF ontbreekt; controleer de verplichte velden. |
413 | Batch te groot | Maximaal 5000 stukken per verzoek; splits de batch. |
207 | Batch deels geslaagd | Geen fout: lees per stuk het veld ok. |
503 | Dienst tijdelijk niet beschikbaar | Probeer het later opnieuw. |
Het bedrijf (de verzender) nodigt je uit als medewerker en vinkt het recht “API & developers” aan. Je logt in met je eigen Plof-identiteit en ziet dan alleen het API-scherm en deze documentatie — je hebt géén inzage in de post van het bedrijf.
Ja. Je maakt losse sleutels aan met een eigen naam, bijvoorbeeld Productie en Test. Elke sleutel kun je apart intrekken zonder de andere te breken — handig bij een sleutelwissel of als een koppeling wegvalt.
Die sleutel werkt direct niet meer: verzoeken ermee krijgen een 403. Bestaande sleutels blijven werken. Maak eerst de nieuwe sleutel aan en zet die in je systeem, en trek de oude daarna pas in.
Stuur een eigen idempotency_key mee (bijvoorbeeld je factuurnummer). Lever je hetzelfde stuk per ongeluk twee keer aan, dan herkent Plof de sleutel en bezorgt het maar één keer.
Bij /stukken lever je één brief aan. Bij /stukken/batch lever je er tot 5000 tegelijk aan; die worden op de achtergrond bezorgd en vormen samen één verzending in het portaal, met een voortgangsoverzicht. Grote stromen (loonstroken, jaaropgaven) horen in een batch.
In het verzendportaal verschijnt bij “Verzonden” een melding “Aandacht nodig” zodra brieven langer dan een paar dagen onderweg zijn zonder opgehaald te worden, of op retour staan — verzameld over al je verzendingen. Zo zie je in één oogopslag of er iets misging.
Nee. Een batch geeft HTTP 207 terug: de goede stukken worden verwerkt, de foute niet. Controleer per stuk het veld ok in resultaten om te zien welke opnieuw moeten.
