Gå til innhold

Dokumentasjon

Den tekniske referansen for API-et. Veiledningene viser hvordan det brukes i praksis; her står alle endepunkter, parametre, felt og regler.

Grunnleggende
Adresse https://api.nasjonalmuseet.no
Versjon /api/v1 (se Stabilitet)
Format JSON, UTF-8. Linked Art som JSON-LD
Nøkkel Headeren X-API-Key
Språk lang=no eller lang=en
Kjørende versjon GET /api/health

Endepunkter

Hvert kall kan prøves i Swagger.

Endepunkt Nivå Beskrivelse
GET /api/v1/objects/{nmId} pub Ett verk
GET /api/v1/objects pub Bla i samlingen
GET /api/v1/objects/text-search pub Søk på ord i katalogen
GET /api/v1/objects/{nmId}/multimedia pub Verkets bilder
GET /api/v1/iiif/manifest/{nmId}.json åpent IIIF-manifest
GET /api/linkedart/object/{id} åpent Linked Art: verk
GET /api/linkedart/object/text-search åpent Linked Art: søk
GET /api/v1/objects/linkedart/{nmId} pub Linked Art med inventarnummer
POST /api/v1/search/interpret pub Forslag til søketekst og filtre
POST /api/v1/search/semantic ext Semantisk søk
POST /api/v1/search/filter ext Filtrering
POST /api/v1/search/similar/{imageId} ext Lignende bilder
POST /api/v1/search/explain ext Hvorfor et bilde traff
GET /api/health åpent Status og versjon

Mer