Requests

Learn how to obtain an initial API key and how to authenticate your requests to the API.

The API uses simple API key–based authentication. This key must be included in every request via the x-api-key HTTP header.

The legacy api-key header is deprecated, but will work until the next major release.

Requesting an API key

An initial API key for your region must be requested by an employee of the relevant education region. We do not issue API keys directly to third-party vendors or external developers without involvement and approval from the region itself. Once approved, the region is responsible for managing the API key and coordinating its use with any third-party applications or integration partners.

API keys do not expire. The region that receives the key is responsible for its secure storage and use, including any third-party integrations that rely on it.

There is no way to retrieve an API key if it’s lost. Please make sure you store the key securely, and optionally create a secondary key as backup.

Example requests

const response = await fetch(
  "https://onderwijsregio.onderwijsin.nl/api/v1/schema",
  {
    method: "GET",
    headers: {
      "x-api-key": process.env.ONDERWIJSREGIO_API_KEY as string,
      "Content-Type": "application/json",
    },
  }
);

const data = await response.json();

$ch = curl_init("https://onderwijsregio.onderwijsin.nl/api/v1/schema");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "x-api-key: " . getenv("ONDERWIJSREGIO_API_KEY"),
        "Content-Type: application/json",
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

import os
import requests

response = requests.get(
    "https://onderwijsregio.onderwijsin.nl/api/v1/schema",
    headers={
        "x-api-key": os.environ["ONDERWIJSREGIO_API_KEY"],
        "Content-Type": "application/json",
    },
)

data = response.json()

curl https://onderwijsregio.onderwijsin.nl/api/v1/schema \
  -H "x-api-key: $ONDERWIJSREGIO_API_KEY" \
  -H "Content-Type: application/json"