API-ets formål

API-et gjør det mulig å hente ut informasjon om digitale helseverktøy som ligger i Verktøykatalogen samt å kunne forskrive disse verktøyene til innbygger.

API-et tilbyr tjenester for å:

• Forskrive et verktøy til innbygger fra behandler-del av verktøyet eller fra EPJ. Når et verktøy forskrives, vil innbygger varsles og enkelt finne det forskrevne verktøyet etter innlogging på Helsenorge. Dette er et alternativ til at behandler logger seg på Verktøyformidleren for å forskrive verktøy til innbygger. Pasienten vil oppleve det helt likt uavhengig av om behandler har brukt Verktøyformidleren eller gjort det direkte fra annen løsning som har tatt i bruk APIet for forskrivning.

• Hente ut en liste med verktøy og deres metadata med mulighet for å filtrere på fagområder, målgrupper, språk, om verktøyet krever forskrivning og om verktøyet kan brukes uten å måtte logge inn på Helsenorge.

• Hente ut en liste med verktøy og deres metadata basert på søk på verktøynavn og predefinerte søkeord.

• Hente ut alle metadata for ett enkelt verktøy

• Hente ut informasjon om hvilke behandlere som har forskrevet verktøyet til aktuell innbygger. Dette er mulig ved at Helsenorge deler informasjon om behandler som har forskrevet verktøyet med verktøyet etter innlogging og oppstart.

Fordeler med API-et

• Tjeneste for å foreskrive verktøy til innbygger gir en enklere prosess for behandler når verktøy skal forskrives direkte fra verktøyet selv eller annen ekstern løsning behandler benytter (som alternativ til å bruke Verktøyformidleren). Det gjør det mulig å sende et verktøy til pasienten direkte fra ønsket løsning f.eks behandler-delen av verktøyet eller direkte fra EPJen. Dette er mest aktuelt for helsepersonell som kun skal forskrive ett spesifikt verktøy og ikke ha fleksibiliteten til å velge ut og forskrive blant alt som ligger i verktøykatalogen.

• Tjenester for å hente ut informasjon om verktøy kan benyttes av eksterne aktører som ønsker å bruke og presentere informasjon om digitale helseverktøy på Helsenorge på i sine løsninger. På denne måten kan eksterne aktører vise utvalgt informasjon om verktøy direkte fra verktøykatalogen fremfor å duplisere og manuelt vedlikeholde informasjon i egen løsning. Informasjonen vi da alltid være oppdatert og synkronisert med siste endringer som er gjort i Verktøykatalogen automatisk.

• Tjeneste for å hente ut informasjon om behandlere som har forskrevet verktøyet til innbyggere gjør det mulig for verktøyene å følge opp bruken og lage funksjonalitet basert på relasjoner mellom innbygger og behandler. Leverandører kan bruke dette til f.eks å kontrollere påkrevde sertifiseringer og lisenser, følge med på bruk og utbredelse og få innsikt i hvilke type behandlere som benytter verktøyet. Det kan også brukes for å opprette nødvendige koblinger mellom innbyggere og pasienter i verktøyet slik at f.eks verktøy med behandler-del kan sørge for at behandler kun ser sine egne pasienter i verktøyet.

Hvordan benytte API-et

Type API

REST

Metode og parametre til endepunktet

Forskriv verktøy til innbygger

• Beskrivelse: Forskrivning av et bestemt verktøy til innbygger. Innbygger vil varsles på Helsenorge og finne forskrevet verktøy under “flisa” verktøy (se funksjonell beskrivelse av Digitale Verktøy). Verktøyet må være definert i Verktøykatalogen på forhånd, og verktøyets unike ID må være kjent i forskrivningsfunksjonen i Verktøyet.

• HTTP-verb: POST

• Tjeneste: verktoy

• Sikkerhetsmodell: System til system

Request

Request eksempel

/verktoyformidleren/api/v1/Verktoy

Parameternavn

Type

Beskrivelse

VerktoyId

guid

Verktøyets unike ID slik det er lagret i Verktøykatalogen

InnbyggerFnr

string

Innbyggers fødselsnummer (type string). Merk! det vil bli feilrespons dersom innbygger ikke er digital aktiv på Helsenorge.

BehandlerHprNr

string

Dette skal være behandlers HPR-nummer dersom dette er kjent i systemet som benytter API-et.

BehandlerFnr

string

Kan benyttes dersom behandlers HPR-nummer ikke er kjent i systemet som benytter API-et

Request eksempel

JSON:

HPR-nummer kjent i system som benytter API:

{
  "VerktoyId": "68ce99fd-6243-4ab0-b5bc-3ca81dbd53ba",
  "InnbyggerFnr": "0506634187",
  "BehandlerHprNr": "123467"
}

JSON:

Kun behandlers fødselsnummer er kjent i systemet som benytter API’et:

• . To metoder for tilgang er tilgjengelige:

  1. HelseId sin autoriseringstjeneste for maskin-til-maskin kan benyttes:

     1. Velg Helsenorge Ekstern API i HelseId sin selvbetjeningsløsning

     2. Velg deretter scope “verktoysendtilinnbygger”

     3. Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId

  2. API-klienten kan alternativt autentisere seg mot Helsenorge Sikkerhetstjeneste.

     1. API-klienten må forhåndskonfigureres på Helsenorge med sin public key

     2. API-et skal benyttes i system-til-system kontekst: 01 - System til System

     3. Deretter kan API-klienten få utsedt et AksessToken fra Helsenorge STS.

  AksessToken som mottas fra HelseId eller Helsenorge STS skal deretter være med i Authorization header i alle HTTP-requestene. Se: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/23789578/02+-+Kall+til+Helsenorge+og+PVK+API+er+og+bruk+av+AccessToken

Request

{
  "VerktoyId": "68ce99fd-6243-4ab0-b5bc-3ca81dbd53ba",
  "InnbyggerFnr": "0506634187",
  "BehandlerFnrBehandlerHprNr": "12067231456123467"
}

Respons

{
  "VerktoyId": "68ce99fd-6243-4ab0-b5bc-3ca81dbd53ba",
  "InnbyggerFnr": "0506634187",
  "BehandlerFnr": "12067231456"
}

Respons

{
  "PseudoId": ""
}

Verktøymetadataliste

• Beskrivelse: Verktøyliste med mulighet for filtrering av metadata. Eventuelle filtre sendes med request som queryparametre.
  Tjenesten støtter paginering, default er 10 verktøy pr. side. Maks antall verktøy pr. side er 50.

• HTTP-verb: GET

• Tjeneste: SelvstendigVerktoy

• Sikkerhetsmodell: System til system

Request

Request eksempel

/v1/SelvstendigVerktoy?Fagomrader=2&Malgrupper=2&Sprak=1&KanLeggesTilAvInnbygger=false&KunAnonymTilgang=true&Siderefereanse=1&AntallVerktoy=20

Request parametre:

Parameternavn

Type

Beskrivelse

Fagomrader

list<enum>

Fagområde som verktøyet tilhører:

1. Psykisk helse

2. Fysisk helse

3. Livsstil

Klassifiseringer

list<string>

SNOMED CT-klassifisering for verktøyet.

Malgrupper

list<enum>

Verktøyets målgrupper:

1. Barn

2. Ungdom

3. Voksne

4. Eldre

Sprak

list<enum>

Hvilke språk som verktøyet støtter

1. Bokmål

2. Nynorsk

3. Engelsk

KanLeggesTilAvInnbygger

bool?

• . To metoder for tilgang er tilgjengelige:

  1. HelseId sin autoriseringstjeneste for maskin-til-maskin kan benyttes:

     1. Velg Helsenorge Ekstern API i HelseId sin selvbetjeningsløsning

     2. Velg deretter scope “verktoykatalog_read”

     3. Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId

  2. API-klienten kan alternativt autentisere seg mot Helsenorge Sikkerhetstjeneste.

     1. API-klienten må forhåndskonfigureres på Helsenorge med sin public key

     2. API-et skal benyttes i system-til-system kontekst: 01 - System til System

     3. Deretter kan API-klienten få utsedt et AksessToken fra Helsenorge STS.

  AksessToken som mottas fra HelseId eller Helsenorge STS skal deretter være med i Authorization header i alle HTTP-requestene. Se: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/23789578/02+-+Kall+til+Helsenorge+og+PVK+API+er+og+bruk+av+AccessToken

Request

Request parametre:

Respons

{
  "SelvstendigVerktoyListe": [
    {
      "VerktoyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Navn": "string",
      "Ingress": "string",
      "Beskrivelse": "string",
      "OpprettetDato": "2023-04-28T14:05:58.923Z",
      "EndretDato": "2023-04-28T14:05:58.923Z",
      "VerktoyFormal": {
        "VerktoyFormalTypeId": 0,
        "VerktoyFormalNavn": "string"
      },
      "FagligAnsvarlig": "string",
      "UtvikletAv": "string",
      "Sprak": [
        {
          "SprakNavn": "string",
          "SprakKode": "string"
        }
      ],
      "Fagomrader": [
        {
          "FagomradeType": 0,
          "FagomradeNavn": "string"
        }
      ],
      "Lenker": [
        {
          "LenkeType": 1,
          "LenkeTypeNavn": "string",
          "Url": "string"
        }
      ],
      "Sokeord": [
        "string"
      ],
      "Malgrupper": [
        {
          "MalgruppeTypeId": 0,
          "MalgruppeNavn": "string"
        }
      ],
      "GrafiskeElementer": [
        {
          "GrafiskElementId": 0,
          "GrafiskElementTypeNavn": "string"
        }
      ],
      "Innholdstyper": [
        {
          "InnholdstypeId": 0,
          "InnholdstypeNavn": "string"
        }
      ],
      "Behandlerinnsyn": "string",
      "Klassifiseringer": [
        {
          "KlassifiseringKode": "string",
          "KlassifiseringNavn": "string"
        }
      ],
      "KreverForskrivning": true,
      "Dataansvarlig": {
        "Organisasjonsnummer": 0,
        "Organisasjonsnavn": "string"
      },
      "AntattTid": 0
    }
  ]
}

Respons-parametere:

Verktøymetadata

• Beskrivelse: Metadata for ett valgt verktøy angitt med en unik id (guid).

• HTTP-verb: GET

• Tjeneste: SelvstendigVerktoy

• Sikkerhetsmodell: System til system

Request

Request eksempel

/v1/SelvstendigVerktoy/08ead360-0d65-448c-ba9e-8a08f0921c90

Parameternavn

Type

Beskrivelse

guid

Unik id for verktøy

Respons

Respons eksempel

• . To metoder for tilgang er tilgjengelige:

  1. HelseId sin autoriseringstjeneste for maskin-til-maskin kan benyttes:

     1. Velg Helsenorge Ekstern API i HelseId sin selvbetjeningsløsning

     2. Velg deretter scope “verktoykatalog_read”

     3. Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId

  2. API-klienten kan alternativt autentisere seg mot Helsenorge Sikkerhetstjeneste.

     1. API-klienten må forhåndskonfigureres på Helsenorge med sin public key

     2. API-et skal benyttes i system-til-system kontekst: 01 - System til System

     3. Deretter kan API-klienten få utsedt et AksessToken fra Helsenorge STS.

  AksessToken som mottas fra HelseId eller Helsenorge STS skal deretter være med i Authorization header i alle HTTP-requestene. Se: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/23789578/02+-+Kall+til+Helsenorge+og+PVK+API+er+og+bruk+av+AccessToken

Request

Respons

{
  "Selvstendigverktoy": {
    "VerktoyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Navn": "string",
    "Ingress": "string",
    "Beskrivelse": "string",
    "OpprettetDato": "2023-05-02T13:28:34.819Z",
    "EndretDato": "2023-05-02T13:28:34.819Z",
    "VerktoyFormal": {
      "VerktoyFormalTypeId": 0,
      "VerktoyFormalNavn": "string"
    },
    "IngressFagligAnsvarlig": "string",
    "BeskrivelseUtvikletAv": "string",
    "OpprettetDato": "2023-05-02T13:28:34.819Z"Sprak": [
      {
        "SprakNavn": "string",
        "SprakKode": "string"
      }
    ],
    "EndretDatoFagomrader": "2023-05-02T13:28:34.819Z", [
     "VerktoyFormal": {
        "VerktoyFormalTypeIdFagomradeType": 0,
        "VerktoyFormalNavnFagomradeNavn": "string"
      },
    "FagligAnsvarlig": "string"],
    "UtvikletAvLenker": "string", [
      {
 "Sprak": [       {"LenkeType": 1,
        "SprakNavnLenkeTypeNavn": "string",
        "SprakKodeUrl": "string"
      }
    ],
    "FagomraderSokeord": [
      {

       "FagomradeTypestring":
0,    ],
    "FagomradeNavnMalgrupper": "string"[
      }{
    ],     "LenkerMalgruppeTypeId": [0,
       { "MalgruppeNavn": "string"
      "LenkeType": 1,}
    ],
    "LenkeTypeNavnGrafiskeElementer": "string",[
      {
 "Url": "string"       }
"GrafiskElementId": 0,
   ],     "SokeordGrafiskElementTypeNavn": ["string"
      "string"}
    ],
    "MalgrupperInnholdstyper": [
      {
        "MalgruppeTypeIdInnholdstypeId": 0,
        "MalgruppeNavnInnholdstypeNavn": "string"
      }
    ],
    "Behandlerinnsyn": "GrafiskeElementerstring",
    "Klassifiseringer": [
      {
        "GrafiskElementIdKlassifiseringKode": 0"string",
        "GrafiskElementTypeNavnKlassifiseringNavn": "string"
      }
    ],
    "InnholdstyperKreverForskrivning": [true,
     "Dataansvarlig": {
 
      "InnholdstypeIdOrganisasjonsnummer": 0,
        "InnholdstypeNavnOrganisasjonsnavn": "string"
    },
    "AntattTid": 0
   }
    ],
    "Behandlerinnsyn": "string",
    "Klassifiseringer": [
      {
        "KlassifiseringKode": "string",
        "KlassifiseringNavn": "string"
      }
    ],
    "KreverForskrivning": true,
    "Dataansvarlig": {
      "Organisasjonsnummer": 0,
      "Organisasjonsnavn": "string"
    },
    "AntattTid": 0
  }
}

Respons-parametere:

Parameternavn

Type

Beskrivelse

VerktoyId

guid

Verktøyets unike id

Navn

string

Verktøyets navn

Ingress

string

Innledende beskrivelse av verktøyet

Beskrivelse

string

Beskrivelse av verktøyet

OpprettetDato

DateTime

Når verktøyet ble opprettet

EndretDato

DateTime

Når verktøyet sist ble endret

VerktoyFormalTypeId

int

Enumverdi for verktøyets formål:

Verdier: 2, 4, 5

VerktoyFormalNavn

string

Navn på verktøyets formål

Verdier:

• Læring (VerktoyFormalTypeId: 2)

• Behandling (VerktoyFormalTypeId: 4)

• Kartlegging (VerktoyFormalTypeId: 5)

FagligAnsvarlig

string

Hvem som har det faglige ansvaret for verktøyet

UtvikletAv

string

Hvem som har utviklet verkøyet

SprakKode

string

Hvilke språk verktøyet støtter.

Verdier:

• "en-GB" (engelsk)

• "nn-NO" (nynorsk)

• "nb-NO" (bokmål)

SprakNavn

string

Språknavn:

Verdier:

• Engelsk

• Norsk Nynorsk

• Norsk Bokmål

FagomradeType

int

Fagområde verktøyet tilhører

Verdier: 1, 2, 3

FagomradeNavn

string

Navn på fagområde:

• Psykisk helse (FagomradeType: 1)

• Fysisk Helse (FagomradeType: 2)

• Livsstil (FagomradeType: 3)

LenkeType

enum

Type lenke tilknyttet verktøyet. Returnerer verdi 50 som er den eneste gyldige verdien i denne responsen.

LenkeTypeNavn

string

Lenketypens navn, returnerer: “Lenke til verktøy“

Url

Uri

Lenke til verkøyet

Sokeord

List<string>

Predefinerte søkeord som beskriver verktøyet

MalgruppeTypeId

int

Id for verkøyets målgrupper

Verdier: 1, 2, 3, 4

MalgruppeNavn

string

Målgruppenavn

Verdier:

• Barn (MalgruppeTypeId: 1)

• Ungdom (MalgruppeTypeId: 2)

• Voksne (MalgruppeTypeId: 3)

• Eldre (MalgruppeTypeId: 4)

GrafiskElementId

int

Id til verkøyets grafiske element

GrafiskElementTypeNavn

string

Type grafisk element

Verdier:

• Bilde

• Ikon

InnholdstypeId

int

Id for verktøyets innholdstype

Verdier: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

InnholdstypeNavn

string

Navn på innholdstype

Verdier:

• Video (InnholdstypeId: 1)

• Podcast (InnholdstypeId: 2)

• Informasjon (InnholdstypeId: 3)

• Oppgaver (InnholdstypeId: 4)

• Spill (InnholdstypeId: 5)

• Chat (InnholdstypeId: 6)

• Forum (InnholdstypeId: 7)

• Egenregistreringer (InnholdstypeId: 8)

• Måleverktøy (InnholdstypeId: 9)

• Anbefalinger og råd (InnholdstypeId: 10)

Behandlerinnsyn

string

Beskriver verktøyets behandlerinnsyn

Verdier:

• “Ingen”

• “Krever”

• “Tilbys i verktøyet”

KlassifiseringKode

string

Klassifiseringskode

KlassifiseringNavn

string

Klassifiseringnavn

KreverForskrivning

bool

Om verktøyet må forskrives av behandler

Organisasjonsnummer

int

Organisasjonsnummer til verktøyets dataansvarlig

Organisasjonsnavn

string

Organisasjonsnavn til verktøyets dataansvarlig

AntattTid

int?

Antatt tid det tar å gjennomføre verktøyet (angitt i minutter).

Verktøysøk

• Beskrivelse: Søk som returnerer liste med navn og id på verktøy basert på verktøynavn og definerte søkeord. Søkeresultatet returnerer opp til 50 verktøy(default), men kan overstyres med paramter 'RowCount'.

• HTTP-verb: GET

• Tjeneste: SelvstendigVerktoy

• Sikkerhetsmodell: System til system

Request

Request eksempel

/v1/SelvstendigVerktoy/SokSelvstendigVerktoy?SokeOrd=test&RowCount=10

Parameternavn

Type

Beskrivelse

SokeOrd

string

Søket søker etter ord som begynner med søkeordet og som må være mellom 3-256 karakterer lang.

RowCount

int

Antall verktøy som ønskes returnert i response. By default returneres det inntil 50 verktøy som er maks antall. Dette kan nedjusteres med denne parameteren.

Respons

Respons eksempel

{
  "SelvstendigVerktoySokeResultat": [
    {
      "VerktoyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Navn": "Verktøy 1"
    },
    {
      "VerktoyId": "13848949-b394-4340-840c-9af49cfdf7da",
      "Navn": "Verktøy 2"
    }
  ]
}

Respons-parametere:

Parameternavn

Type

Beskrivelse

VerktoyId

guid

Verktøyets unike id

Navn

string

Verktøyets navn

Grafisk element

• Beskrivelse: Tjeneste for å hente ett bilde/ikon med id til det grafiske elementet som innparameter.

• HTTP-verb: GET

• Tjeneste: GrafiskElement

• Sikkerhetsmodell: System til system

Request

Request eksempel

/verktoy/v1/GrafiskElement/5

Parameternavn

Type

Beskrivelse

int

Id til grafisk element

Respons

Ved suksess returneres bildefil, HTTP-status 200.

Veiledningstjeneste

}
}

Respons-parametere:

Verktøysøk

• Beskrivelse: Søk som returnerer liste med navn og id på verktøy basert på verktøynavn og definerte søkeord. Søkeresultatet returnerer opp til 50 verktøy(default), men kan overstyres med paramter 'RowCount'.

• HTTP-verb: GET

• Tjeneste: SelvstendigVerktoy

• Sikkerhetsmodell: Sikkerhetsmodell: System til system. To metoder for tilgang er tilgjengelige:

  1. HelseId sin autoriseringstjeneste for maskin-til-maskin kan benyttes:

     1. Velg Helsenorge Ekstern API i HelseId sin selvbetjeningsløsning

     2. Velg deretter scope “verktoykatalog_read”

     3. Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId

  2. API-klienten kan alternativt autentisere seg mot Helsenorge Sikkerhetstjeneste.

     1. API-klienten må forhåndskonfigureres på Helsenorge med sin public key

     2. API-et skal benyttes i system-til-system kontekst: 01 - System til System

     3. Deretter kan API-klienten få utsedt et AksessToken fra Helsenorge STS.

  AksessToken som mottas fra HelseId eller Helsenorge STS skal deretter være med i Authorization header i alle HTTP-requestene. Se: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/23789578/02+-+Kall+til+Helsenorge+og+PVK+API+er+og+bruk+av+AccessToken

Request

Respons

{
  "SelvstendigVerktoySokeResultat": [
    {
      "VerktoyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Navn": "Verktøy 1"
    },
    {
      "VerktoyId": "13848949-b394-4340-840c-9af49cfdf7da",
      "Navn": "Verktøy 2"
    }
  ]
}

Respons-parametere:

Grafisk element

• Beskrivelse: Tjeneste for å hente ett bilde/ikon med id til det grafiske elementet som innparameter.

• HTTP-verb: GET

• Tjeneste: GrafiskElement

• Sikkerhetsmodell: Sikkerhetsmodell: System til system. To metoder for tilgang er tilgjengelige:

  1. HelseId sin autoriseringstjeneste for maskin-til-maskin kan benyttes:

     1. Velg Helsenorge Ekstern API i HelseId sin selvbetjeningsløsning

     2. Velg deretter scope “verktoykatalog_read”

     3. Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId

  2. API-klienten kan alternativt autentisere seg mot Helsenorge Sikkerhetstjeneste.

     1. API-klienten må forhåndskonfigureres på Helsenorge med sin public key

     2. API-et skal benyttes i system-til-system kontekst: 01 - System til System

     3. Deretter kan API-klienten få utsedt et AksessToken fra Helsenorge STS.

  AksessToken som mottas fra HelseId eller Helsenorge STS skal deretter være med i Authorization header i alle HTTP-requestene. Se: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/23789578/02+-+Kall+til+Helsenorge+og+PVK+API+er+og+bruk+av+AccessToken

Request

Respons

Ved suksess returneres bildefil, HTTP-status 200.

Veiledningstjeneste

• Beskrivelse: Tjeneste for å oppdatere metadata på en eksisterende veiledningstjeneste

• HTTP-verb: PUT

• Tjeneste: Veiledningstjeneste

• Sikkerhetsmodell: Sikkerhetsmodell: System til system. To metoder for tilgang er tilgjengelige:

  1. HelseId sin autoriseringstjeneste for maskin-til-maskin kan benyttes:

     1. Velg Helsenorge Ekstern API i HelseId sin selvbetjeningsløsning

     2. Velg deretter scope “verktoyadminveiledning”

     3. Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId

  2. API-klienten kan alternativt autentisere seg mot Helsenorge Sikkerhetstjeneste.

     1. API-klienten må forhåndskonfigureres på Helsenorge med sin public key

     2. API-et skal benyttes i system-til-system kontekst: 01 - System til System

     3. Deretter kan API-klienten få utsedt et AksessToken fra Helsenorge STS.

  AksessToken som mottas fra HelseId eller Helsenorge STS skal deretter være med i Authorization header i alle HTTP-requestene. Se: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/23789578/02+-+Kall+til+Helsenorge+og+PVK+API+er+og+bruk+av+AccessToken

Request

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Telefon": "string",
  "Url": "string",
  "Apningstider": [
    {
      "Dag": 1,
      "FraKl": "string",
      "TilKl": "string",
      "ApenHeleDagen": true
    }
  ]
}

Behandlerinformasjon

• Beskrivelse: Tjeneste for å hente informasjon om en behandler som har sendt et verktøy til innbygger

• HTTP-verb: GET

• Tjeneste: Behandler

• Sikkerhetsmodell: Innbygger OIDC

Request

Request eksempel

v1/Behandler?VerktoyId=95d2290a-ecbc-4525-9593-f35d4ee4e42d

Request-parametere

Respons

Respons-eksempel

{
  "Id": "565513636",
  "IdType": "HPR",
  "Navn": "Venstre Morfar"
}

Respons-parametere

Feilmeldinger

Swagger

Swagger - Verktøy External API

Autentisering og autorisasjon

Swagger

Swagger - Verktøy External API

Miljøer

Standard for hvordan URL-en til API-et vil se ut i alle miljøene: https://<BaseUrl>​/verktoy/v1​/

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

Terms and Conditions

Vilkår og betingelser for bruk av API-et: Vilkår og betingelser for bruk av APIer og kommunikasjonsprosesser

Begrensninger

Ved forskrivning av verktøy må den eksterne aktøren på forhånd kjenne verktøyets unike GUID i Verktøykatalogen.

Testing

Oppsett av API-klient i test-miljø avtales som en del av kundeoppkoplingen

Versjonering og endringer

Dett er første versjon av API-et.