Introduktion til API

Hvordan får jeg adgang?

For at kunne bruge api.jobindsats.dk, skal du have en nøgle. Den får du ved at sende en mail til jobindsats@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 på jobindsats.dk, opfordres du til at læse om behandling af dine personoplysninger i tilknytning til en brugerprofil her.

I mailen skal følgende fremgå:

• Navn
• Organisation
• E-mail adresse

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

Der gives i udgangspunktet kun én nøgle pr. organisation. Det betyder, at hvis du arbejder i en organisation, der allerede har adgang, vil du blive bedt om at kontakte organisationens kontaktperson for at få organisationens nøgle. Hvis du er del af en organisation, der 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 brugen af api.jobindsats.dk.

Den skal du gerne læse før du går i gang.

 

Hvordan kommer jeg i gang?

Du kommer i gang ved at læse brugerdokumentationen og ved at kigge på de eksempler, som er her på siden.

• Link til brugerdokumentationen (herunder eksempler i cURL)
• Link til andre eksempler i Windows Powershell, Microsoft Excel, Python, R og Power BI

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

 

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

Der er nedenstående opmærksomhedspunkter, du som bruger af api.jobindsats, skal være opmærksom på:

1. Når der skal hentes data vha. Jobindsats API, kan der kun hentes data fra én måling pr. forespørgsel.
2. Når data specifikt ønskes i CSV-format eller JSON-format, skal det altid angives i forespørgslen.
3. Det kan være nødvendigt under visse omstændigheder, at URL-strengen i forespørgslen er URLencoded. Dvs. 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. På grund af diskretionering kan data ikke summeres.
5. Data er levende, og det er derfor en god ide, at trække data igen fra tidligere perioder.
6. API'et er ikke tilgængelig i dette interval kl. 22-23.
7. Større kald, typisk mere end 200.000 celler, kan føre til time out.

 

Hvad gør jeg, hvis jeg oplever fejl?

Ved oplevelsen af tekniske fejl ved anvendelsen af api.jobindsats.dk, kan du sende en mail til jobindsats@star.dk. Emnefeltet skal indeholde ”vedr. fejl på api.jobindsats.dk” og mailen bør indeholde tidspunktet for fejlen og gerne et curl-eksempel (uden nøgle/token), der leder til fejlen.