Struktur på API

API-et består av ett endepunkt som inngang til uthenting av alle typer ressurser. Det er mulig å splitte opp i forskjellige endepunkter utfra dette endepunktet dersom det er ønskelig – se detaljer under paginering. Vi setter ingen føringer for hva dette endepunktet skal hete, annet enn at det må være en gyldig URL.

Paginering

Hvis ønskelig, kan resultatene i API-et deles opp i sider. Dette skjer ved hjelp av Link-headere i responsen fra API-et. Inngangspunktet til API-et skal fortsatt være ett stabilt endepunkt, og hvert endepunkt sender en lenke med rel="next" til neste side. Dersom det ikke finnes flere sider, inkluderes ingen lenker i responsen. Dette vil se slik ut:

Content-Type: application/ld+json
Link: <https://lenke-til-neste-side/>; rel="next"
...resten av HTTP-responsen...

Vi setter ingen krav til hvordan lenken skal se ut. Dere står derfor fritt til å velge egen pagineringsimplementasjon, så lenge man kan følge en uavbrutt rekke lenker fra utgangspunktet for å hente ut komplette data. Dette innebærer også at dere kan dele opp i separate endepunkter for ulike ressurstyper, så lenge alle blir inkludert i kjeden av lenker.