Metodens formål

Metoden kan brukes av eksterne aktører for å undersøke om en bestemt innbygger er aktiv på Helsenorge eller ikke. Basert på svaret, kan det eksterne systemet vurdere om det kan og bør kommunisere med innbyggeren via Helsenorge og/eller om det må benytte alternative kanaler. Dersom formålet er å lagre innbyggers digitale status i eget system bør metoden bare benyttes etter at metoden DigitaltAktivStatusEndringer først er benyttet.

benytte API'et

Detaljert dokumentasjon av metoden

Autentisering og autorisasjon

Alle API’er krever at klienten på forhånd har autentisert seg mot vår Sikkerhetstjeneste og fått utstedt et aksesstoken som skal være med i tjenestekallene til det enkelte API. DigitalAktiv tjenesten krever ikke at kallet utføres i context av en innlogget bruker dvs. UseCase 1 (system-til-system) beskrevet her kan benyttes: 01 - System til System

Type API

REST

HTTP verb

Det skal benyttes POST og alltid https.

For å unngå at innbyggers fødselsnummer er en del av parameterne i URL’en, og dermed vil vises i browser-historikk, benyttes alltid POST med parametere i requestens body.

Request

Response

Swagger

https://eksternapi-hn-mas-02.int-hn.nhn.no/digitaltaktiv/swagger/index.html

Miljøer

Standard for hvordan URL’en til API’et vil se ut i alle miljøene: https://<miljø>/DigitaltAktiv/api/<versjon>/DigitaltAktivOmraade

Oversikt over tilgjengelige miljøer finnes her: Miljøer Testmiljøer og endepunkter

Terms and Conditions

Vilkår og betingelser for bruk av API'et. Generell oversikt over alle vilkår finnes her: Vilkår og betingelser som regulerer datadelingfor bruk av APIer

Beskriv eventuelle ytterligere detaljer her.

Begrensninger

Hvis API'et har begrensninger, feks på antall kall totalt, pr sekund, etc, så bør dette beskrives her.

Beskriv også hva som evt skjer når begrensningene nås, feks om brukeren vil få en feilmelding når den har nådd kvoten sin, samt hva brukeren da kan gjøre for å løse problemet.

Quick Start

Request (eks.)

Header:

Image Removed

Image Added

Body:

{
  "fnr": "07118600295",
  "omraade": 1
}

Response (eks.)

Body:

{
    "erDigitaltAktivSelv": true,
    "erDigitaltAktivViaAndre": true
}

Testing

Beskriv gjerne også vanlige problemer brukeren kan oppleve, med evt referanse til aktuelt kapittel (slik som autorisering og autentisering).

Hvis det er forskjeller mellom testmiljø og produksjon, utover hvilket endepunkt som benyttes, bør det også beskrives. Feks hvis det kreves ulike sertifikater, ulik type sikkerhet, etc.

Feilmeldinger

Beskriv her hvilke feilmeldinger brukeren kan få og hva de betyr

Ved HTTP-statuskoder som tilsier at det har oppstått en feil returneres også en respons med feilkode og feilmelding.

Eks:

{  "Code": "SEC-110000",  "Message": "Token is expired or invalid"}

Versjonering og endringer

Beskriv hvordan versjonering håndteres for API'et. Noen punkter som bør med:

• Har de ulike versjonene forskjellig namespace? Feks blalbalba/v1/detteeretendepunkt

• Hvor mange versjoner vil vedlikeholdes samtidig?

• Hvor lenge vedlikeholdes gamle versjoner av API'et?

• Hvordan varsles brukerne om endringer, nye versjoner og frafall av støtte til gamle versjoner?

Dokumentasjon av tidligere versjoner

Det gjeldende dokumentet er dokumentasjon av den nyeste versjonen av API'et. I dette avsnittet bør det ligge lenke til dokumentasjon av eventuelle tidligere versjoner av API'et.