REST VideoBaseURL
API-navn | BaseUrlApi? |
|---|---|
Funksjonelt område | |
API-versjon og dato publisert | Versjon 0.7 Apr 13, 2026 |
Status | Under utvikling |
API-dokumentasjon sist endret | Apr 13, 2026 |
Teknologi | REST
|
Metodens formål
Metoden REST Videolenker anvendes av videoleverandørene for å administrere baseURL for gydlige videolenker
Løsningen er under utvikling og er enda ikke tilgjengelig for utprøving
Detaljert dokumentasjon av metoden
Autentisering og autorisering
HelseId sin autoriseringstjeneste for maskin-til-maskin skal benyttes:
Velg Helsenorge Ekstern API i HelseId sin selvbetjeningsløsning
Velg deretter scope “ikke-definert”
Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId
Se ytterligere detaljer her: 3. Ekstern applikasjon kaller Helsenorge API i systemkontekst
AksessToken som mottas fra HelseId skal deretter være med i Authorization header i alle HTTP-requestene. Se: 2. Ekstern innbyggerløsning kaller Helsenorge API i innbyggerkontekst
HTTP-verb
Det skal benyttes GET, POST og DELETE og alltid https. AksessToken skal være med i Authorization header. Se her: 2. Ekstern innbyggerløsning kaller Helsenorge API i innbyggerkontekst
Request GET
Plassering | Navn | Type | Beskrivelse |
|---|---|---|---|
Header | Authorization: bearer {access-token} | - | Aksess token som klienten fikk fra Helsenorge sikkerhetstjeneste etter å ha autentisert/autorisert seg mot denne. |
Content-Type | application/json | Parametere i body er JSON | |
Query | KunAktive | bool (valgfri) | Hvis satt og er false så returneres og video base-URLer som er markert som “ikke aktive” i databasen. |
Response GET
Plassering | Navn | Type | Beskrivelse | |
|---|---|---|---|---|
Body | BaseUrls | List<BaseUrl> |
| |
|
| Id | Guid |
|
|
| Url | string |
|
|
| OpprettetDato | DateTime |
|
|
| SistEndretDato | DateTime |
|
|
| Organisasjonsnummer | string |
|
|
| LeverandoOrganisasjonsnummer | string |
|
|
| LeverandorGuid | Guid |
|
|
| ErAktiv | bool |
|
|
| VideolosningErAktiv | bool |
|
|
| LevernadorErAktiv | bool |
|
Request POST
Plassering | Navn | Type | Beskrivelse |
|---|---|---|---|
Header | Authorization: bearer {access-token} | - | Aksess token som klienten fikk fra Helsenorge sikkerhetstjeneste etter å ha autentisert/autorisert seg mot denne. |
Content-Type | application/json | Parametere i body er JSON | |
Body | Id | bool (valgfri) |
|
| OrganisasjonsnummerAnvender | int |
|
| Url | string |
|
| ErAktiv | bool |
|
Response POST
Plassering | Navn | Type | Beskrivelse |
|---|---|---|---|
Body | Id | Guid |
|
Request DELETE
Plassering | Navn | Type | Beskrivelse |
|---|---|---|---|
Header | Authorization: bearer {access-token} | - | Aksess token som klienten fikk fra Helsenorge sikkerhetstjeneste etter å ha autentisert/autorisert seg mot denne. |
Content-Type | application/json | Parametere i body er JSON | |
Query | Id | Guid |
|
Response DELETE
Plassering | Navn | Type | Beskrivelse |
|---|---|---|---|
Body | Deleted | bool |
|
Miljøer
URL for å nå endepunktet (forskjellig pr miljø): https://<miljø>/ikkedefinertenda/api/v1
Oversikt over tilgjengelige miljøer finnes her: Testmiljøer og endepunkter
Vilkår for bruk
Generelle vilkår for bruk av APIer finnes her: Vilkår og betingelser for bruk av APIer og kommunikasjonsprosesserarchived
Feilmeldinger
Følgende responskoder kan forventes fra Helsenorge:
Kode | Beskrivelse |
|---|---|
200 | Alt OK |
400 | Validering av request feiler |
401 | Autorisasjon er feil eller mangler |
403 | Tilganger mangler |
500 | Midlertidig feil, prøv igjen senere |
Ved HTTP-statuskoder som tilsier at det har oppstått en feil returneres også en respons med feilkode og feilmelding.
Eksempler:
{ "Code": "SEC-110000", "Message": "Token is expired or invalid"}
{ "Code": "HT-000602", "Message": "Ingen leverandørløsninger av type video funnet"}
{ "Code": "HT-000603", "Message": "BaseUrl 6b110d06-8611-4667-8465-0ade5a8d61bb not found"}
{ "Code": "HT-000604", "Message": "Request OrganisasjonsnummerAnvender er tom"}
{ "Code": "HT-000604", "Message": "Request Url er tom"}
{ "Code": "HT-000604", "Message": "Ingen videoleverandør funnet"}
{ "Code": "HT-000604", "Message": "Du kan ikke oppdatere URL og/eller OrganisasjonsnummerAnvender for BaseUrl med id 9791885a-bdfd-4df3-802c-c0e87faf7e08, fordi den er i bruk av 19 videolenker"
{ "Code": "HT-000605", "Message": "Du har ikke tilgang til å oppdatere BaseUrl med id 2508b4fc-41dc-46ef-89f8-63f5dea689d7"