ENG
api-illustrasjon

Noark 5 tjenestegrensesnitt

Noark 5 tjenestegrensesnitt (API) er en spesifikasjon av en dataprotokoll for maskinell kommunikasjon med Noark-løsninger. Noark 5 tjenestegrensesnittet versjon 1.0 er nyeste versjon og følger opp betaversjonen som ble lansert som del av forrige versjon av Noark-standarden i oktober 2016.

Formålet med Noark 5 tjenestegrensesnittet er å standardisere og forenkle kommunikasjonen mellom de ulike systemene i forvaltningen. Tjenestegrensesnittet er en spesifikasjon av en dataprotokoll for maskinell kommunikasjon med Noark-løsninger. Betaversjonen ble levert fra Samdok-prosjektet høsten 2016. Sommeren 2017 innledet Arkivverket og Arkitektum AS (som utviklet betaversjonen) et pilotsamarbeid med Fredrikstad kommune, Evry og HK Data for å verifisere betaversjonen (Proof of Concept).

Ved lansering av Noark 5.5.0 besluttet Arkivverket at tjenestegrensesnittet skulle videreutvikles og forbedres. Spesifikasjonen og alle åpne saker har vært publisert på GitHub, slik at diskusjon og videreutvikling har vært åpent tilgjengelig for alle interesserte.

Arkivverket har også samarbeidet med NUUG ved Petter Reinholdtsen og OsloMet ved Thomas Sødring. De har testet Nikita mot tjenestegrensesnittetets betaversjon og mot versjon 1.0. Denne testingen har resultert i mange nyttige innspill og gode eksempler.

Det er fortsatt uklarheter og endringsbehov som ikke er løst, og Arkivverket vil videreutvikle tjenestegrensesnittet på GitHub fremover, men N5.5.0 versjon 1.0 av tjenestegrensesnittet er klar for å tas i bruk og for videre testing.

Det er viktig at det er flere som tester tjenestegrensesnittet uavhengig av hverandre, for å sikre at vi får et entydig API som tolkes likt av alle leverandører av fagsystem og arkivkjerner. Det er også viktig at flere leverandører deltar i diskusjonen og melder inn forslag til endringer eller feil på GitHub for å påvirke den videre utviklingen av tjenestegrensesnittet. 

Høsten 2019 inviterte Arkivverket leverandørene og samarbeidspartnere til et samarbeidsmøte og workshops for å diskutere videre utvikling av tjenestegrensesnittet.

Betaversjonen av tjenestegrensesnittet ble utarbeidet av Riksarkivet i tett samarbeid med KS KommIT, som en oppgave under Arkivverkets Samdok-program, ledet av KS KommIT og finansiert av KS, KMD og Riksarkivet. En rekke leverandører og brukere var involvert i arbeidet. 

Sluttrapport fra arbeidsgruppen finnes i filoversikten nedenfor. For mer informasjon om arbeidet som ble gjort med tjenestegrensesnittet, se samlesiden om SAMDOK-prosjektet her.

Grensesnittet har vært gjennom høring i K10-samarbeidet (de ti største kommunene i Norge) og referansegruppen for arbeidet. Det kom inn mange merknader, og disse ble innarbeidet, både i tjenestegrensesnittet og i versjon 4.0 av Noark 5. 

Merknadene til tjenestegrensesnittet medførte bl.a. at flere nye metadataelementer måtte tas inn i Noark 5, og i vedleggene som beskriver metadataene. Endringer i metadata medfører ingen endringer i avleveringsformatet i første omgang. 

Tjenestegrensesnitt ble juni 2016 gjort tilgjengelig for leverandører som ønsket å innarbeide grensesnittet i sine løsninger.

Utvikling av tjenestegrensesnittet henger tett sammen med videre utvikling av Noark 5 standarden. 

Filene som inngår i beta-løsningen, kan lastes ned nedenfor. 

UML-modell/datamod for søk og innsyn.ell er lagt inn i kapittel 7 i grensesnittfilen (over), samt på metadatakatalogen 
http://arkivverket.metakat.no for søk og innsyn.

KS har fått et nytt testmiljø, dokumentert på https://ks-no.github.io/fiks-plattform/testmiljo/

XML-skjemaer (.xsd) ligger på http://skjema.kxml.no/arkivverket/noark5/v4.0/

Relasjonslenker for REST API ligger på http://rel.kxml.no/noark5/

Eksempelkode for testgrensesnitt ligger på https://github.com/Arkitektum/N5-net