Ga naar inhoud

API

ERP-NL exposeert interne applicatie-API's en een beperkte publieke API voor machine-to-machine integraties.

Interne API

De interne API wordt door de frontend gebruikt en staat onder /api/*. backend/main.py registreert routergroepen voor onder meer:

  • auth, users en organizations;
  • bank accounts, payments, batches en payment files;
  • payables;
  • commitments;
  • GL;
  • reconciliation;
  • cash application;
  • direct debits;
  • attachments;
  • audit events;
  • notifications;
  • platform, RBAC en setup seed jobs.

Interne endpoints vertrouwen op authenticatie, organisatiecontext en permission checks.

Publieke API

De publieke API staat onder /api/v1/* en is bedoeld voor externe systemen. De huidige publieke documentatie richt zich op payment requests.

Beschikbare documentatie-endpoints:

  • /api/v1/docs voor Swagger UI;
  • /api/v1/redoc voor ReDoc;
  • /api/v1/openapi.json voor het OpenAPI-schema.

Meer detail staat in de bestaande referentiepagina Public API.

Integratie-eisen

Publieke integraties gebruiken OAuth2 Client Credentials via Keycloak. Requests moeten JSON accepteren en voor muterende calls Content-Type: application/json gebruiken.

Interne en publieke API's moeten organisatie-isolatie respecteren. Nieuwe endpoints horen expliciete autorisatie, consistente foutresponses en tests te krijgen.