Algemene informatie

Let op: deze API is nog in ontwikkeling en nog niet algemeen beschikbaar.
Pynter streeft ernaar om vanaf Q4 2026 een nieuwe API aan te bieden op basis van het REST-protocol. Op deze pagina wordt alvast toegelicht hoe deze API wordt vormgegeven.
Werking
De nieuwe Pynter-API is een REST-API. Authenticatie gebeurt met de OAuth 2.0 Client Credentials-flow. Authorisatie gebeurt door middel van role-based access control (RBAC) met fine-grained permissions. Dat wil zeggen dat API-clients een rol toegekend krijgen en daarnaast eventueel nog specifieke toegang kunnen krijgen voor endpoints of operaties die normaal buiten die rol vallen.
Via de API kan met data van meerdere organisaties worden gewerkt, mits de API client de juiste permissions daarvoor heeft. Per API-request kan van één organisatie data worden opgehaald of aangepast.
Aanvragen gegevens
Om toegang te krijgen tot de API dient een verzoek ingediend te worden via de betreffende accountmanager. Er wordt dan een API client klaargezet met de juiste toegang. Vervolgens worden de ClientID en API Key op een veilige manier gedeeld. Daarnaast wordt aangegeven voor welke organisaties deze Client werkt.
URLs
De volgende URLs zijn relevant voor de API:
Productie
Acceptatie
Auth-server
https://auth.pynter.nl
https://auth.acc.pynter.nl
API-documentatie
https://api.pynter.nl/docs
https://api.acc.pynter.nl/docs
API
https://api.pynter.nl
https://api.acc.pynter.nl
Gebruik
Voor gebruik van de API wordt gebruik gemaakt van de OAuth 2.0 Client Credentials-flow. Hiermee wordt een kort geldige token aangevraagd waarmee data uit de API opgehaald kan worden.
Request een token op https://auth.pynter.nl/realms/pynter/protocol/openid-connect/token
Bereid de API-request voor
Vul de API-token in in de 
Authorization: Bearer <TOKEN> header
Vul de 
Pynter-Company-Key header in met de key van de organisatie waarvoor je data gaat verwerken. Je hebt deze key van ons ontvangen bij het aanvragen van een API-Client.
Doe de request naar https://api.pynter.nl/v1/endpoint.
De authenticatieserver biedt een overzicht van de openid-configuratie via https://auth.pynter.nl/realms/pynter/.well-known/openid-configuration.
Testen
De API kan getest worden op onze acceptatieomgeving. De URLs hiervan komen overeen met de productie-URLs, maar vallen allemaal onder het subdomein 
acc.pynter.nl, bijvoorbeeld https://auth.acc.pynter.nl in plaats van https://auth.pynter.nl.