API - Adgang

Formål

Du kan via denne vejledning se, hvad der skal til for at få adgang til API'et til DitmerFlex.

Forudsætning

• Du skal have opsat et API til DitmerFlex
• Du skal have lavet en DNS registrering til API'et
• De ovenstående punkter er ikke relevante for SaaS-kunder, da de allerede har et API sat op. Dette kan tilgåes på https://api.<installations navn>.ditmerflex.dk.

Vejledning

For at få adgang til api'et kræver der at man sender en header ved navn "publicApiToken" med alle sine kald som indeholder en token fra DitmerFlex.

På nuværende tidspunkt er det kun muligt at trække denne token igennem en API brugerimport som beskrevet i nedenstående afsnit. Dette er kun en midlertidig løsning og måden at administrere tokens på vil blive ændret på sigt.

Se dokumentationen for API-brugerimport for hvordan man trækker et token.

Sikkerhed

Alt kommunikation mellem API'et og klienten kører over HTTPS. Det betyder, at alt data der flyder til/fra API'et er krypteret. Derudover kræver alle endpoints i API'et, at ovenstående token sendes med for hvert request. Således er det kun autoriserede klienter der har adgang til API'et. 

Som en yderligere faktor i sikkerheden, er det muligt at whiteliste en eller flere IP-adresser, så det kun er klienter der kalder fra disse adresser, der får adgang til API'et. Dette gøres i administrationsdelen af DitmerFlex under "Systemkonfigurationer":

Snitfladebeskrivelse

Alle kald i api'et er beskrevet med et dokumentationsværktøj, der giver et overblik over hvilke kald der er samt hvilken data der modtages og returneres.

Du kan finde dokumentationen for dit DitmerFlex api ved at indtaste følgende url i din browser:

• SaaS miljø: https://api.<installations navn>.ditmerflex.dk
• OnPremise miljø: https://api.<dit ditmerflex subdomæne>.<dit domæne>.dk

Du kan også finde dokumentationen på vores demo miljø: http://api.demo.ditmerflex.dk/

Eksempel

Med dette token vil man nu være i stand til at kalde alle kald på api'et. Nedenstående viser et PowerShell script der kalder api'et hvor headeren er sat.

Invoke-RestMethod -Method 'Get' -Headers @{'Content-Type'='application/json';'publicApiToken'='InsertDitmerFlexTokenHere'} -Uri 'https://api.InsertDitmerFlexUrlHere/PATH'