Slik får du tilgang til et API hos Statens vegvesen
Her beskriver vi de ulike typene av API-er vi har, og forklarer hvordan du kan få tilgang til dem.
Statens vegvesen har svært mange API-er av ulike typer. Mange av dem er tilgjengelige for alle, mens andre bare er tilgjengelige internt. For eksempel må du være ansatt i Statens vegvesen for å benytte et API der du kan melde feil i Vegvesenets interne systemer, mens et API som opplyser om fartsgrensa på en vei, er tilgjengelig for alle.
Det finnes også en god del API-er som bare er tilgjengelige for samarbeidspartnere som har hjemmel i lov eller forskrift. Det gjelder for eksempel et API som verifiserer at det er betalt toll for et kjøretøy, eller sjekker kontrollhistorikken på et kjøretøy. Disse API-ene er bare tilgjengelige for tollvesenet og politiet, men hvis andre får hjemmel til det, vil de også kunne bruke dem.
API-ene finner du i dataportalen vår. Der finner du også lenker til mer informasjon om hvert enkelt API. Noen av dem finner du også i den nasjonale Felles datakatalog (data.norge.no).
API-er som er tilgjengelige for alle
Åpne API-er
Åpne API-er er tilgjengelige for alle brukere uten noen form for registrering. Det er ingen begrensning på hvem som kan bruke dem, og det er bare å ta dem i bruk.
Åpne API-er med registrering
Det er en del API-er som alle kan bruke, men som du må registrere deg for å få tilgang til. Registreringen består gjerne i at du bekrefter at informasjonen du henter gjennom API-et, ikke blir benyttet til ulovligheter, og at du oppgir Vegvesenet som kilde overfor tredjepart hvis du videreformidler informasjonen. Når du bekrefter dette, blir du tildelt et token som vi sjekker ved kall mot API-et. Hvis det er noe feil med tokenet (for eksempel at det er foreldet), blir du bedt om å registrere deg en gang til.
For noen API-er må du oppgi en e-postadresse. Den bruker vi til å fortelle deg om endringer og planlagt nedetid, og informere deg når data du henter ut, blir lagt inn i et annet API. Dette skal sikre at du får den informasjonen du trenger, men vi har ingen mulighet til å kontrollere at e-postadressen er reell.
Åpne API-er med verifisert e-postadresse
I helt spesielle tilfeller må du oppgi en reell e-postadresse for å benytte et et API. Da må du klikke på en lenke eller oppgi en kode du har fått på e-post, for å få utdelt token for bruk av API-et. Denne teknikken er kjent fra mange andre løsninger, og API-et vil fungere som det skal, når du har fått tokenet.
API-er med identifikasjon fra ID-porten
Åpne API-er med identifikasjon fra ID-porten
Enkelte av de mest brukte API-ene er tilgjengelige for alle, men vi verifiserer hvem brukeren er. Årsaken kan være alt fra personvern, der vi for eksempel ønsker å vite hvem som sjekker hvem eieren av et kjøretøy er, til at vi ønsker å sikre at det er eieren av et kjøretøy som selger det. Da må det sendes med et autentiseringstoken fra ID-porten i kallet på API-et, og Vegvesenet verifiserer at tokenet er korrekt. Hvis det er aktuelt, verifiseres det i selve API-et at korrekt person er identifisert også i tokenet.
For nesten alle API-er som bare skal utlevere informasjon, er det tilstrekkelig å hente ut data fra produksjonsmiljøet. Da er det ikke noe testmiljø, og all testing kan gjøres mot produksjonsmiljøet. Hvis det er et testmiljø for et rent lese-API, er dette beskrevet i API-beskrivelsen det er lenket til i Dataportalen.
Noen API-kall starter prosesser hos Vegvesenet. Et eksempel på dette er et eierskifte av et kjøretøy. For slike API-er er det testmiljøer. API-beskrivelsen det er lenket til i Dataportalen, forklarer hvordan du får tilgang til testmiljøene. I mange tilfeller er det et fast brukernavn/passord, men i enkelte tilfeller må du bestille tilgang.
Lukkede API-er med identifikasjon fra ID-porten
En del API-er er ikke tilgjengelige for alle, men benytter token fra ID-porten for å finne ut av om brukeren er en legitim bruker. Det gjelder for eksempel hvis brukeren skal levere en EU-kontroll (PKK – periodisk kjøretøykontroll) for et kjøretøy. Da må brukeren være registrert hos Statens vegvesen.
For slike API-er er det testmiljøer. API-beskrivelsen det er lenket til i Dataportalen, forklarer hvordan du får tilgang til testmiljøene. I mange tilfeller er det et fast brukernavn/passord, men i enkelte tilfeller må du bestille tilgang.
API-er med identifikasjon fra Maskinporten
API-er med krav om avtale
Enkelte av API-ene våre får du kun tilgang til hvis du har en avtale. Det gjelder blant annet API-er for utstedelse av prøveskilt og API-er for registrering av brovedlikehold. Disse API-ene har tilknyttede test-API-er i egne testmiljøer. API-beskrivelsen det er lenket til i Dataportalen, forklarer hvordan du får tilgang til testmiljøene. I mange tilfeller er det et fast brukernavn/passord, men i enkelte tilfeller må du bestille tilgang.
API-er med krav om hjemmel
Mange av API-ene våre er kun tilgjengelige for offentlige aktører med hjemmel til å behandle eller oppdatere den aktuelle informasjonen. Det gjelder API-er for verifikasjon av betaling av toll for et kjøretøy, API-er for oppdatering av prikkinformasjon i førerkort og API-er for verifikasjon av kjøreseddel. Disse er kun tilgjengelige for utviklere og brukere knyttet til organisasjonen som har hjemmel for denne behandlingen. For slike applikasjoner håndterer organisasjonen selv brukerne sine.
Nye organisasjoner med hjemmel kan se hvem de skal kontakte, i API-beskrivelsen det er lenket til i Dataportalen.
API-er med identifikasjon fra Helseporten
API-er med krav om avtale
Vi har noen svært spesielle API-er som du kun får tilgang til hvis du er identifisert fra en annen tilbyder enn ID-porten og Maskinporten. Det er API-er som bare kan benyttes av bestemte typer registrert helsepersonell. Da må det sendes med et korrekt token og, avhengig av API-et, et matchende token fra Maskinporten. Disse API-ene har tilknyttede test-API-er i egne testmiljøer. API-beskrivelsen det er lenket til i Dataportalen, forklarer hvordan du får tilgang til testmiljøene. I mange tilfeller er det et fast brukernavn/passord, men i enkelte tilfeller må du bestille tilgang.