Gå til innhald

DataverseNO API

Programmeringsgrensesnittet (API-et) til DataverseNO gjer det mogleg å samhandla programmatisk med DataverseNO-arkivet, til dømes for å søkja etter datasett, henta ut metadata, lasta ned filer og utføra tillatne deponerings- og datasettoperasjonar.

Førehandskunnskap om API er nødvendig.

Denne rettleiinga føreset at du allereie kjenner til API, HTTP-førespurnader, autentisering, JSON og kommandoline- eller programmeringsverktøy for å senda API-førespurnader. DataverseNO-brukarstøtta kan hjelpa med spørsmål som gjeld DataverseNO-arkivet, men tilbyr ikkje generell opplæring eller feilsøking i korleis ein brukar API. Dersom du ikkje kjenner til bruk av API, tilrår vi at du brukar det grafiske brukargrensesnittet i DataverseNO, slik det er beskrive andre stader på denne informasjonsnettstaden (info.dataverse.no).

DataverseNO API følgjer API-et til den opne programvara Dataverse, som DataverseNO-arkivet er basert på. Basis-URL-en for API-førespurnader til DataverseNO er:

https://dataverse.no/api/

Dataverse gjer mykje av funksjonaliteten i det grafiske brukargrensesnittet til DataverseNO tilgjengeleg gjennom REST-baserte API-ar.

API-token for DataverseNO

Nokre API-operasjonar i DataverseNO som gjeld offentleg innhald, krev ikkje autentisering. Operasjonar du utfører gjennom brukarkontoen din i DataverseNO, krev vanlegvis eit API-token.

Opprett eller hent API-tokenet ditt for DataverseNO

  1. Logg inn i DataverseNO.
  2. Vel kontonamnet ditt øvst til høgre.
  3. Vel API Token.
  4. Opprett eit token, eller vis tokenet du allereie har.

API-tokenet ditt for DataverseNO er knytt til brukarkontoen din i DataverseNO og gjer det mogleg å utføra API-førespurnader med tilgangane dine. Handsam tokenet som eit passord: Ikkje del det eller ta det med i skript, programvarearkiv, loggfiler eller andre stader der det kan verta eksponert. Når du har fullført oppgåvene dine ved hjelp av API-et, tilbakekall ("revoke") API-tokenet for å hindre at det blir brukt på nytt.

Når eit API-endepunkt i DataverseNO krev autentisering, sender du tokenet i HTTP-headeren X-Dataverse-key:

curl -H "X-Dataverse-key: YOUR_API_TOKEN" \
  "https://dataverse.no/api/v1/dataverses/root/contents"

Det er betre å bruka HTTP-headeren enn å ta tokenet med som ein URL-parameter, fordi URL-ar kan bli lagra i nettlesarhistorikkar, serverloggar og andre system.

Tilgangar i DataverseNO

API-førespurnader til DataverseNO krev dei same tilgangane som handlingar du utfører gjennom nettgrensesnittet til DataverseNO. Eit API-token for DataverseNO gjev deg ikkje fleire tilgangar. Du kan berre visa avgrensa innhald eller utføra operasjonar som å oppretta, redigera og publisera datasett dersom DataverseNO-kontoen din har dei nødvendige tilgangane.

API-dokumentasjon for DataverseNO

Du finn tilgjengelege API-endepunkt for DataverseNO, førespurnadsparameterar, svarformat og døme i den offisielle Dataverse API Guide. Dokumentasjonen dekkjer mellom anna:

  • å koma i gang med DataverseNO API;
  • autentisering og API-token for DataverseNO;
  • å søkja etter samlingar, datasett og filer i DataverseNO;
  • å henta metadata for datasett frå DataverseNO;
  • å lasta ned filer frå DataverseNO;
  • å oppretta og oppdatera datasett i DataverseNO;
  • å lasta opp filer til DataverseNO; og
  • klientbibliotek for programmeringsspråk som Python og R.

Bruk dokumentasjon som samsvarar med programvareversjonen i DataverseNO

Den nyaste versjonen av Dataverse API Guide kan skildra funksjonar som enno ikkje er tilgjengelege i DataverseNO. Kontroller Dataverse-versjonen som står i botnteksten i DataverseNO-arkivet, og byt om nødvendig ut /latest/ i URL-en til dokumentasjonen med dette versjonsnummeret.

Per oktober 2026 køyrer DataverseNO på Dataverse v6.11. Den tilhøyrande dokumentasjonen er tilgjengeleg på:

https://guides.dataverse.org/en/6.11/api/

Den installerte Dataverse-versjonen står i botnteksten på landingssida til DataverseNO-arkivet.

DataverseNO-brukarstøtte

Før du kontaktar DataverseNO-brukarstøtta, bør du kontrollera at:

  • API-endepunktet og parametrane for DataverseNO er dokumenterte for Dataverse-versjonen som DataverseNO bruker;
  • DataverseNO-kontoen din har tilgangane som den aktuelle operasjonen krev;
  • API-tokenet ditt for DataverseNO er gyldig og blir sendt på rett måte; og
  • førespurnadsteksten i API-førespurnaden til DataverseNO har den forventa syntaksen og datastrukturen.

Dersom problemet ser ut til å vera spesifikt for DataverseNO, kan du kontakta arkivforvaltninga på support@dataverse.no.