Kom godt i gang med API'et
Vejledningen herunder beskriver hvordan API'et tages i brug. Til eksemplerne anvendes vores Online værktøj samt Postman, der er et populært værktøj til afprøvning af API'er.
Få adgang til data
Vores data er frit tilgængelige, og kan hentes af alle der har interesse i dem. Men for at få adgang til API'et skal der benyttes en API nøgle. For at få en nøgle skal man registreres, og have en profil hos Styrelsen for IT og læring. Registreringen sker udelukkende for at vi kan være i kontakt med vores brugere, og give en bedre service. Man vil eksempelvis modtage besked fra os, hvis vi oplever driftsforstyrrelser, eller hvis der er funktioner i API'et vi er nød til at ændre eller udfase. Registreringen er selvfølgelig også fuldstændig gratis, og tager ikke lang tid.
Opret bruger
Er du ny på API'et, og har du ikke en UniLogin konto, så start her.
Log ind
Log ind med en allerede eksistende bruger. Har du en UniLogin konto kan denne også bruges.
Byg en forespørgsel
Vores Online værktøj kan bruges til at udforske data og bygge data forespørgsler nemt og hurtigt.
Start med at indtaste en API nøgle, og marker eventuelt at nøglen skal huskes. Nøglen vil herved være indtastet på forhånd, hvis værktøjet benyttes på et senere tidspunkt.
Hvis en brugbar nøgle er indtastet, vil Område, Emne og Underemne blive aktiveret.
Lav et valg i alle tre felter for at udvælge et datasæt.
Når et datasæt er valgt, kan en forespørgsel bygges.
1. Vælg et eller flere nøgletal. Mindst ét nøgletal skal være valgt. Nøgletallene er de måltal eller værdier, der kan rapporteres på. Det kan eksempelvis være karaktergennemsnit eller trivselsmålinger.
2. Vælg et eller flere detaljeringer. Mindst én detaljering skal være valgt. Detaljeringer er de måder nøgletallene kan splittes. Det kan eksempelvis være kommuner, hvilket vil betyde, at nøgletallene vil blive vist per kommune.
3. Lav eventuelt filtreringer. Det er ikke nødvendigt at tilføje filtre, men det kan give et mindre datasæt, hvilket i nogle situationer kan være en fordel. Alle detaljeringer kan også anvendes som filtre, ved at klikke på det lille filter ikon.
Hvis en filter knap er blevet klikket, vises en liste med elementer fra den valgte detaljering. Vælg de elementer der ønskes medtaget og tryk Gem.
En forespørgsel bliver løbende bygget, mens der vælges fra nøgletal og detaljeringer.
Hvis forespørgslen skal bruges i en ikke formatteret form (uden linjeskift og indrykninger), kan formatteringen nemt fjernes. Fjern bare markeringen i Formatér tjekboksen.
Test forespørgslen
En forespørgsel bliver løbende bygget, mens der vælges fra nøgletal og detaljeringer. Når alle valg er foretaget, er det muligt at teste forespørgslen, og se et eksempel på data.
Klik på TEST knappen for at hente data.
Hvis datasættet er meget stort, vil det ikke være alle data der bliver vist. Det vil kun være et mindre udsnit.
Opsætning af Postman
For en generel introduktion til Postman, se deres egen introduktion til produktet.
Start med at lave en collection og oprette et nyt request. Klik på Authorization og indtast login oplysninger som beskrevet herunder.
1. Skift forespørgslen om til et POST og indtast den fulde URL til Skema punktet.
2. Skift autoriseringen over til Bearer Token.
3. Kopier API nøglen ind i Token feltet.
Opsæt herefter Postman til at benytte statistik punktet. Kopier til start Skema forespørgslen, og skift URL så det i stedet er statistik punktet der anvendes (https://api.uddannelsesstatistik.dk/Api/v1/statistik).
Postman er nu klar til anvendelse.
Hent data fra API'et
Hvis en forespørgsel er blevet bygget, kan statistik punktet nu anvendes til at hente et datasæt.
Skift til Statistik forespørgslen, og udfyld som vist herunder.
1. Skift forespørgslen om til Raw og vælg JSON som format.
2. Indtast en forespørgsel. Hvis ikke en tidligere forespørgsel er blevet bygget, så prøv eventuelt at anvende følgende.
3. Klik til slut på Send.
API'et returnerer nu et datasæt baseret på forespørgslen.