API-dokumentasjon for innmelding av yrkessykdom og skade
Velkommen til dokumentasjon for integrasjon av Navs yrkesskade API
Introduksjon
API for innmelding av yrkesskade eller sykdom består av to deler:
- API for mottak av en skademelding.
- Kodeverk for å hente gyldige verdier til flere av feltene i en skademelding.
Rolletyper
Den skadelidtes rolletype definerer kontrakten for skademelding API og hvilke kodeverdier som er gyldige.
Innmelderens rolletype
I hovedsak skal virksomhetsrepresentant benyttes som innmelderens rolletype.
Kodeverk API
APIet er bygget opp slik at det som tidligere var flere forskjellige typer skademeldinger (arbeidstaker, elev, militær, etc.) nå kan dekkes av ett og samme endepunkt med en felles datamodell. For å muliggjøre dette, bruker vi et kodeverk som spesifiserer gyldige verdier for de forskjellige feltene per skademeldingstype.
REST APIet er dokumentert med OpenApi3 spesifikasjon
Det er også mulig å benytte Kodeverk utforsker for å se hvilke koder og kodeverk som er tilgjengelig
| miljø | |
|---|---|
| DEV | https://yrkesskade-kodeverkutforsker.ekstern.dev.nav.no |
| PROD | https://yrkesskade-kodeverkutforsker.nav.no |
Skademelding API
Yrkesskade-melding-api er et REST API som tar imot yrkesskademeldinger. Det er lagt opp til å benyttes på to måter:
- Intern, direkte konsumering av Navs egen frontend-applikasjon for yrkesskadeinnmelding
- Ekstern konsumering av tredjepartsaktører via yrkesskade-ekstern-gateway
REST APIet er dokumentert med en OpenApi3 spesifikasjon
Tilgang
For interne konsumenter
Interne konsumenter må autentisere seg med Azure AD, type server–server, som beskrevet i nais-dokumentasjonen.
For eksterne konsumenter
Eksterne konsumenter må autentisere seg med et Maskinporten-token for å kunne sende inn skademeldinger.
Vi som API-tilbydere må registrere konsumentens organisasjonsnummer for at denne autentiseringen skal fungere.
Maskinporten har en egen guide for hvordan man
kan sette opp tilgang.
Det mest aktuelle per nå er å sette
opp delegert tilgang,
slik at en organisasjon kan sende inn yrkesskademeldinger via en tredjeparts leverandørsystem.
Eksterne konsumenter må som nevnt gå via URLen til yrkesskade-ekstern-gateway for å sende inn yrkesskademeldinger til
oss.
Dette er måten å tilgjengeliggjøre vårt API til internett på, ved å kreve et gyldig Maskinporten-token med egendefinerte
scopes.
Du kan kontakte oss på 55 55 33 36 (velg tastevalg 1 for arbeidsgivere) for å få mer informasjon om
integrasjonsmuligheter og bli registrert hos oss som godkjent Maskinporten-konsument.
URLer
Det er forskjellige URLer avhengig av om konsumerende applikasjon er intern (Nav) eller ekstern.
Fremgangsmåte
Se egen side
Endringslogg
En av fordelene ved bruk av REST API er at nye elementer i kontrakten ikke vil ødelegge integrasjonen for konsumenter, men det kan likevel være endringer som er verdt å legge merke til.
Hvis du oppdager en endring som ikke er nevnt slik at integrasjonen ikke fungerer som det er dokumentert,
gi gjerne en tilbakemelding slik at vi kan få oppdatert dette dokumentet. Siste endringer finner du her