Oppslagstjenesten REST

Introduksjon

Kontaktregisteret sin oppslagstjeneste tilbys gjennom et OAuth2 beskyttet REST-API. Dette gjør det enkelt å implementere integrasjoner mot registeret.

Bruk av Oauth2

Tilgangskontrollen til api’et benytter seg av flyten som er beskrevet i Server til server autorisasjon med Oauth2

Merk at funksjonalitet for lokal kopi (endringsmeldinger) ikke er støttet over Oauth2-grensenittet.

Tilgjenglige scopes

Det er 1-1 mapping mellom OAuth2 scopes og informasjonsbehov-elementet brukt i SOAP-API’et. Se begrepskatalogen for Kontaktregisteret.

scope beskrivelse
global/kontaktinformasjon.read Returnerer epostadresse og mobilnummer + tidspunkt for sist oppdatering
global/varslingsstatus.read Returnerer status for om kontaktinfomasjonen kan brukast for varsling iht. eForvaltningsforskrifta sin §32
global/sikkerdigitalpost.read Returnerer adresse for digital post til innbygger
global/sertifikat.read Returnerer brukerens krypteringssertifikat ved sending av digital post
global/spraak.read Returnerer brukerens foretrukne språk for kommunikasjon med det offentlige.

Det vil alltid returneres reservasjonsstatus for brukeren.

Endepunkt

Oppslagstjenesten sin REST-tjeneste tilbyr følgende endepunkt for søk på 1…1000 personer:

OpenAPI-dokumentasjon ligg her: https://oidc-ver2.difi.no/kontaktinfo-oauth2-server/rest/swagger-ui.html#/Personer

miljø url
VER1 https://oidc-ver1.difi.no/kontaktinfo-oauth2-server/rest/v1/personer
VER2 https://oidc-ver2.difi.no/kontaktinfo-oauth2-server/rest/v1/personer
YT2 https://oidc-yt2.difi.eon.no/kontaktinfo-oauth2-server/rest/v1/personer
PROD https://oidc.difi.no/kontaktinfo-oauth2-server/rest/v1/personer

Merk: Man vil oppnå vesentlig bedre ytelse (målt i personer/sekund) ved å slå opp 1000 personer i gangen kontra tusen enkelt-oppslag.

Følgende header-parametere må brukes på request:

Parameter Verdi
Http-metode POST
Authorization Bearer <utstedt access_token>

Body i requesten er en JSON-struktur med et element personidentifikatorer som skal inneholde en liste med inntil 1000 personidentifikatorer.

Eksempel på forespørsel

POST /rest/v1/personer
Content-type: application/json
Authorization: Bearer SWDQ_pVct3HIzsIaC3zHDuMmIqffr4ORr508N3p0Mtg=

{
 "personidentifikatorer" : [ "23079422568" ]
}

Eksempel på respons

{
  "personer":
    [
      {
         "personidentifikator": "23079421936",
         "reservasjon": "NEI",
         "status": "AKTIV",
         "kontaktinformasjon":
         {
            "epostadresse": "23079421936-test@minid.norge.no",
            "epostadresse_oppdatert": "2018-06-29T10:14:52+02",
         }
      }
   ]
}