Migration Overview

What changes?

If you are already using the Student API (previously: Leerlingen API) or Invoice API (previously: Rekeningen API), only one thing changes:

• New endpoint URL — route your calls through the APIM gateway instead of directly to the backend. This includes two adjustments to your URL:

  • a new host and path prefix (the APIM gateway URL)

  • a version segment added to the path (e.g. students/{version} or invoices/{version})

The request/response structure of both APIs remains identical.

Authentication — nothing changes

Authentication works the same as it does today. You already obtain a JWT Bearer token from the identity server and include it on your requests — that does not change.

Authorization: Bearer <your-existing-token>

The only update needed is the endpoint URL. See the Migration Guide for your API.

Which API are you migrating?

Select your API in the top navigation, or jump directly to the relevant guide:

• Student API – Migration Guide

• Invoice API – Migration Guide

• Invoice GraphQl API – Migration Guide

Implementation guides (PDF)

The original technical specification for each API is available as a PDF document. These PDFs describe the direct backend API and were written before the APIM gateway was introduced — use them as a reference for request/response structure, but refer to the migration guides on this portal for the correct APIM endpoint URLs.