Api

Forespørsel om alle tilgjengelige ressurser i API. N5 kjerne må minimum støtte arkivstruktur. Sakarkiv og møteOgUtvalgsbehandling er valgfritt.

Standard relasjonslenker som kan benyttes her:

  • https://rel.arkivverket.no/noark5/v4/api/arkivstruktur
  • https://rel.arkivverket.no/noark5/v4/api/sakarkiv
  • https://rel.arkivverket.no/noark5/v4/api/moeteogutvalgsbehandling
  • https://rel.arkivverket.no/noark5/v4/api/administrasjon
  • https://rel.arkivverket.no/noark5/v4/api/loggingogsporing
  • https://rel.arkivverket.no/noark5/v4/api/rapporter

Request

GET http://n5test.kxml.no/api

Accept: application/vnd.noark5-v4+json eller application/vnd.noark5-v4+xml

Response

Content-Type: application/vnd.noark5-v4+json


{
"_links": [
{
"href": "http://localhost:49708//api/arkivstruktur",
"rel": "https://rel.arkivverket.no/noark5/v4/api/arkivstruktur",
"templatedSpecified": false
},
{
"href": "http://localhost:49708//api/sakarkiv",
"rel": "https://rel.arkivverket.no/noark5/v4/api/sakarkiv",
"templatedSpecified": false
},
{
"href": "http://localhost:49708//api/moeteogutvalgsbehandling",
"rel": "https://rel.arkivverket.no/noark5/v4/api/moeteogutvalgsbehandling",
"templatedSpecified": false
},
{
"href": "http://localhost:49708//api/administrasjon",
"rel": "https://rel.arkivverket.no/noark5/v4/api/administrasjon",
"templatedSpecified": false
},
{
"href": "http://localhost:49708//api/loggingogsporing",
"rel": "https://rel.arkivverket.no/noark5/v4/api/loggingogsporing",
"templatedSpecified": false
},
{
"href": "http://localhost:49708//api/rapporter",
"rel": "https://rel.arkivverket.no/noark5/v4/api/rapporter",
"templatedSpecified": false
}
]
}

Alternativt som XML

Content-Type: application/vnd.noark5-v4+xml


<LinkListe
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.kxml.no/rest/1.0">
<_links>
<href>http://n5test.kxml.no//api/arkivstruktur</href>
<rel>https://rel.arkivverket.no/noark5/v4/api/arkivstruktur</rel>
</_links>
<_links>
<href>http://n5test.kxml.no//api/sakarkiv</href>
<rel>https://rel.arkivverket.no/noark5/v4/api/sakarkiv</rel>
</_links>
<_links>
<href>http://n5test.kxml.no//api/moeteogutvalgsbehandling</href>
<rel>https://rel.arkivverket.no/noark5/v4/api/moeteogutvalgsbehandling</rel>
</_links>
<_links>
<href>http://n5test.kxml.no//api/administrasjon</href>
<rel>https://rel.arkivverket.no/noark5/v4/api/administrasjon</rel>
</_links>
<_links>
<href>http://n5test.kxml.no//api/loggingogsporing</href>
<rel>https://rel.arkivverket.no/noark5/v4/api/loggingogsporing</rel>
</_links>
<_links>
<href>http://n5test.kxml.no//api/rapporter</href>
<rel>https://rel.arkivverket.no/noark5/v4/api/rapporter</rel>
</_links>
</LinkListe>

Autentisering med OpenID Connect

APIet benytter autentisering av brukere ved hjelp av OpenID Connect. For å benytte APIet må brukeren være autentisert på forhånd og alle forespørsler mot APIet må gjøres sammen med et access token. Access token sendes med i Authorization-headeren i alle forespørsler. Access token er en Base64 enkodet streng som du får fra identitetsserveren ved autentisering.

Authorization: Bearer yJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng....

Testapiet har foreløpig kun en url som krever autentisering, http://n5test.kxml.no/api/secure.

Forspørsler uten gyldig access token vil bli avvist med HTTP Status 401.
Forespørsler med gyldig access token vil gi samme respons som http://n5test.kxml.no/api.