Gå til hovedinnhold

Skaffe tilgang til Utdanningsregister API

Utdanningsregisterets API krever autentisering via Maskinporten, Digitaliseringsdirektoratets løsning for sikker system-til-system autentisering.

Tilgjengelige scopes

Utdanningsregisteret tilbyr to scopes basert på ditt behov:

ScopeTilgangBeskrivelse
sikt:utdanningsregisteret/utdanning.readLesetilgangHent utdanningsdata via GraphQL queries
sikt:utdanningsregisteret/utdanning.writeLese- og skrivetilgangRapporter og oppdater utdanningsdata via GraphQL mutations

Skaffe tilgang via Maskinporten

For å få tilgang til API-et må du:

  1. Opprett Maskinporten-integrasjon: Registrer en OAuth2-klient i Maskinportens selvbetjeningsportal
  2. Søk om tilgang til scope: Legg til ønsket scope i din integrasjon
  3. Hent access token: Generer JWT-basert token for API-kall

Komplett veiledning:

Selvbetjeningsportaler:

API-endepunkt

Når du har fått tilgang til scopet og hentet access token fra Maskinporten, kan du kalle API-et:

Test-miljø:

https://api-test.fsweb.no/graphql

Produksjon:

https://api.fsweb.no/graphql

Nødvendige headers:

Authorization: Bearer <access_token>
Feature-Flags: beta,experimental
Feature Flags

API-et krever Feature-Flags: beta,experimental header for alle forespørsler.