Introduktion til API

Hvad er API?

Når du henter data på Jobindsats, kan du vælge at bruge vores API (Application Programming Interface). Det er en softwareløsning, hvor du, ved hjælp af programmering, kan automatisere processen, når du henter data fra vores databank.

Skal du fx bruge de samme data igen og igen, kan du ved hjælp af programmering lave en direkte forbindelse mellem Jobindsats og det program, du bruger til at arbejde videre med data i. Fx hvis du arbejder med data i et regneark, såsom Excel.

Når du først har oprettet forbindelsen og hentet data, slipper du for at gå på Jobindsats og hente de samme data ned manuelt hver gang, der kommer opdaterede tal. I stedet kan du opdatere dine egne tabeller og grafer med nye tal direkte i det program, du arbejder i.

 

Hvordan får jeg adgang?

For at du kan bruge api.jobindsats.dk, skal du have en adgangsnøgle. Den får du ved at sende en mail til jobindsats-api@star.dk, hvor der i emnefeltet står "Ansøgning om adgang til api.jobindsats.dk".

Før du sender en ansøgning om adgang til API-løsningen, opfordrer vi dig til at læse om
behandling af dine personoplysninger i tilknytning til en brugerprofil her.

I ansøgningsmailen skal følgende fremgå:

• Navn
• Organisation
• E-mailadresse

Du vil herefter modtage en nøgle inden for 14 dage, hvis oplysningerne i ansøgningen er fyldestgørende. I forbindelse med ferie kan der gå længere tid.

Vi giver i udgangspunktet kun én nøgle per organisation. Hvis du arbejder i en organisation, der allerede har adgang, vil du derfor blive bedt om at kontakte organisationens kontaktperson for at få organisationens nøgle. Hvis din organisation ikke har en nøgle, vil I blive bedt om at udpege en kontaktperson.

Når du modtager nøglen til api.jobindsats.dk, får du udleveret retningslinjerne for at bruge api.jobindsats.dk.
Vi opfordrer til, at du læser retningslinjerne, før du går i gang.

 

Hvordan kommer jeg i gang?

Vi har lavet et dokument (brugerdokumentation), der beskriver, hvordan du kan bruge api.jobindsats.dk. Eksemplerne i brugerdokumentationen tager udgangspunkt i computerprogrammet cURL.

Link til brugerdokumentationen (herunder eksempler i cURL)

Du kan også se eksempler på, hvordan du tilgår API'et fra andre softwaresystemer her:

Link til andre eksempler i Windows Powershell, Microsoft Excel, Python, R og Power BI

Det kan være en fordel at installere et såkaldt ”curl-program”, såsom Git Bash, til at lære api.jobindsats.dk at kende.

 

Hvad skal jeg være opmærksom på?

Når du bruger api.jobindsats.dk, skal du være opmærksom på følgende punkter:

1. Når du henter data fra databanken, kan du kun hente data fra én måling per forespørgsel.
2. Hvis du vil have data i CSV-format eller JSON-format, skal du altid angive det i forespørgslen.
3. I nogle tilfælde kan det være nødvendigt, at URL-strengen i forespørgslen er ”URLencoded”. Det vil sige, at fx ”mellemrum” skal angives som ”%20” og "æ" skal angives som "%C3%A6", ”ø” skal angives som ”%C3%B8” og "å" skal angives som "%C3%A5"
4. Data kan ikke summeres. Det skyldes, at al vores data på Jobindsats er diskretioneret for at sikre og beskytte oplysninger om den enkelte person.

   Når du henter data på Jobindsats, vil du derfor kunne opleve, at der står "." i stedet for et tal, eller der er blanke celler, når du henter data via api.jobindsats.dk.

5. Data er levende og kan løbende ændre sig. Det er derfor en god ide at trække data igen fra tidligere perioder.
6. API'et er ikke tilgængeligt mellem klokken 22.00-23.00
7. Hvis du forsøger at hente store mængder data på en gang, typisk mere end 200.000 celler, kan det føre til time out.

 

Hvad gør jeg, hvis jeg oplever fejl?

Hvis du oplever fejl, når du bruger api.jobindsats.dk, kan du sende en mail til jobindsats-api@star.dk. I emnefeltet skal du skrive ”vedr. fejl på api.jobindsats.dk”. I mailen skal det fremgå, hvornår fejlen er opstået, og du må meget gerne indsætte et ”curl-eksempel” (uden nøgle/token), der leder til fejlen.