API: Adgang
Formål:
Du kan via denne vejledning se, hvad der skal til for at få adgang til API'et til XFlow.
Forudsætning
Du skal have opsat et API til XFlow
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ås på: https://api.<installationsnavn>.ditmerflex.dk
Sidst redigeret: 06/03/2025
1. Vejledning
Før man rører ved API'et, skal man tænke over, om der kunne være nogen, der bruger det. Det er derfor vigtigt, at man ikke trækker en ny token uhensigtsmæssigt. Det er kun systemadministratorer, der kan ændre og trække i nye tokens for organisationen.
For at benytte API'et til jeres XFlow-miljø kræver det, at miljøet er sat op. Man kan tjekke, om det er sat op ved at tage URL'en under opsætning og indsætte den i browseren. Vær igen opmærksom på, at man ikke skal trække en ny token, da den allerede kan være i brug.
2. Sikkerhed
Al kommunikation mellem API'et og klienten kører over HTTPS. Det betyder, at alle data, der yder 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 XFlow under "System > Indstillinger":
Her whitelister du en IP-adresse
3. 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 XFlow API ved at indtaste følgende URL i din browser:
SaaS miljø: https://api.<installations navn>.ditmerflex.dk
On-Premise miljø: https://api.<dit ditmerflex subdomæne>.<dit domæne>.dk
Du kan også finde dokumentation på vores demo miljø:
http://api.demo.ditmerflex.dk/
4. API Token via. XFlow
For at få et API token gennem XFlow skal man følge en specifik proces. Du opretter selve API brugerimporten inde i XFlows administrationsdel, under menupunktet “Import > API Brugerimport”. Når du opretter ny, vil adressen til API’et vises i brugergrænsefladen, hvor du får et token. Dette token skal du bruge til at logge på API’et med. Gem derfor dette token.
Det er altid muligt at generere et nyt token i brugergrænsefladen, men du skal være opmærksom på, at hvis du trækker et nyt token, så bliver det gamle ugyldigt, hvilket kan ødelægge en eksisterende opsætning.
Generér et nyt Token i XFlow
