engAPI nøkler - Utdanningsdirektoratet/KL06-LK20-public GitHub Wiki

API Keys in Grep

Se norsk versjon: API-nøkler

Starting in the fall of 2026, the Norwegian Directorate for Education and Training (Utdanningsdirektoratet) will introduce API keys for accessing Grep data (REST API, does not apply to SPARQL). This is being implemented to ensure stable operations, provide better insight into usage patterns, and simplify technical support for our users.

See the implementation schedule below

How to Obtain an API Key

All users of the REST API must register and generate a key through our developer portal:

👉 API Management Portal (Azure API Management)

Procedure:

  1. Log in or register a new user in the portal.
  2. Select the product "Ubegrenset tilgang" (we will only offer one "product").
  3. Create a subscription.
  4. You will be assigned a Primary Key and a Secondary Key (both are valid) following a manual approval process by our team.

Implementation

The key must be included as an HTTP header in all requests.

  • Header name: x-api-key
  • Value: your_api_key_here

Example (REST):

GET https://data.udir.no/kl06/v201906/aarstrinn/aarstrinn1
Header: x-api-key: 123456789abcdef...


Implementation Schedule

We are following a phased rollout with a transition period during the summer to ensure all users have sufficient time to update their systems:

Date Phase Effect
June 1, 2026 Launch API keys become available. Use is optional but strongly recommended.
August 3, 2026 Notification Direct follow-up with identified high-volume consumers still running anonymously.
Sept. 1, 2026 Enforcement Anonymous calls (without a key) will be restricted via Rate Limiting (typically approx. 100/60 sec. or 1.6 per sec.).

Why are we introducing this?

  • Better Support: We can identify the requester and provide targeted assistance in case of errors.
  • Stability: We can throttle traffic from individual actors who unintentionally overload the service.
  • Security: Protection against misuse and ensuring quality of service for all users.

Ref: GREPF-2653 and GREPF-2838