Met de API koppel je je eigen systeem direct aan POM Collect: processen aanmaken, betalingen doorgeven en documenten aanleveren, helemaal automatisch. Vraag toegang aan bij POM, bouw je koppeling in de testomgeving en ga daarna live. De technische details per endpoint staan in de API-documentatie.
Zo begin je
- Vraag toegang tot de API aan bij POM. Je krijgt een client ID en een client secret, apart voor je testomgeving en je productieomgeving.
- Vraag met je client ID en client secret een token op bij
POST /oauth/token. Een token is een uur geldig; daarna vraag je een nieuw token op. - Stuur het token mee in elke aanroep, als Bearer-token in de header
Authorization. - Bouw en test je koppeling in de testomgeving. Zet hem pas daarna over naar productie.
Gebruik je nu nog API v2, dan kun je API v3 ernaast gebruiken. Je hoeft niet alles in één keer om te bouwen; nieuwe functies komen alleen in API v3.
De limiet op het aantal aanroepen
Elke omgeving heeft een budget van 5000 punten per minuut, voor alle endpoints samen. De meeste aanroepen kosten 1 punt.
| Aanroep | Punten |
|---|---|
| Een gewone aanroep, zoals een proces aanmaken of een betaling doorgeven | 1 |
| Een document aanleveren, los of samen met een proces | 40 |
| Elke aanroep in de testomgeving | 10 keer zoveel (eigen budget) |
Met documenten verwerk je dus maximaal 125 per minuut. Is je budget op, dan krijg je status 429 en vertelt de header X-RateLimit-Retry-After na hoeveel seconden je verder kunt. In elk antwoord zie je in X-RateLimit-Remaining hoeveel punten je nog hebt.
Waarom documenten meer punten kosten
De portal verwerkt elk document direct, binnen dezelfde aanroep: controleren, opslaan en zichtbaar maken voor je klant. Pas daarna krijg je antwoord. Je weet dus meteen of het document is geaccepteerd en hoeft niet achteraf te controleren of alles goed is gegaan. Dat kost meer rekenkracht dan een gewone aanroep.
De limiet is bewust voorzichtig gekozen. Zo duurt een grote batch altijd even lang, ook als andere organisaties tegelijk aanleveren. Een batch van 60.000 documenten duurt ongeveer acht uur. Plan zo'n batch daarom 's nachts of buiten kantooruren in.
Goed om te weten
- De API-documentatie is openbaar. Je kunt de link naar je IT-partner sturen.
- Sla het
collection_order_iduit het antwoord op. Daarmee spreek je het proces later direct aan. - Bouw in je koppeling een nieuwe poging in na een 429, met de wachttijd uit de header.