Opsætning af Public API
Formål:
XFlow-installationen udstiller et API, der kan udvikles op imod. Med dette API er det muligt at lave kreative løsninger og løse et problem på præcis den måde, man som kunde ønsker. Der findes en lang række af endpoints. De omhandler alt fra blanketter, PDF'er, brugerimport, værdilister m.m. som du kan læse om i denne artikel.
Dette er en teknisk brugermanual, som gennemgår opsætning af XFlow’s Public API. At det er en teknisk manual betyder, at den ikke henvender sig til alle brugere af XFlow, men i stedet til de mere tekniske brugere og lokale IT-afdelinger.
Sidst redigeret: 31/03/2025
OBS: Du kan se et eksempel her.
1. Værd at vide inden du går i gang
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 en systemadministrator, der kan ændre og trække i nye tokens for organisationen.
For at benytte API'et til jeres XFlow-miljø kræver det, at det 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. Sådan tilgår du API’et på Administrationssiden
For at tilgå API’et på Administrationssiden skal du trykke på “Import” i menuen til venstre og derefter vælge “API Brugerimport”.
Her kan du se, hvor du kan finde API Brugerimport:
Når du har trykket på “API Brugerimport” kan der ske to ting:
1) Hvis der ikke er sat API op for din organisation, kommer denne side frem
2) Hvis der er sat et API op for din organisation, vil denne side komme frem
Vær dog opmærksom på, at dette ikke nødvendigvis er ensbetydende med, at API’et er opsat på serveren. Er du i tvivl eller har brug for opsætning, bedes du kontakte vores support.
3. Sådan tjekker du API’et
For at tjekke om API’et fungerer, klikker du på de tre prikker yderst til højre og vælger “Opsætning” i den menu, der kommer frem.
Her finder du “Opsætning”:
Når du trykker på “Opsætning”, popper der et nyt vindue frem, der hedder “Opdater API indstillinger”. I dette vindue kan du finde en URL.
Her finder du URL’en:
Bemærk, at hvis du trækker et nyt token, så vil det gamle blive ugyldigt. Du skal bruge dit token, når du opsætter integrationen, så sørg for at kopiere det og gemme det et sikkert sted.
Når du har fundet URL’en, skal du blot kopiere den og tilgå den i din browser.
URL’en burde lede til denne side:
Her kan du se de forskellige endpoints og derved dokumentationen til API’et. Kommer denne side ikke frem, skal du kontakte Supporten for yderligere information.
4. Dokumentation på endpoints
Ved at trykke på hvert endpoint kan mulighederne og kravene ses. Hvis API'et ikke er opsat, kan du se dokumentationen
gennem linket her:
Har du spørgsmål omhandlende funktionalitet, er du velkommen til at kontakte XFlow.
Den token, du kan trække, er 'organisationsstærk'. Det vil sige, at den hører til den organisation, du står på, når den trækkes. Denne token tillader dig at bruge API'et. Når man har trukket en token én gang, er det den samme, indtil man trækker en ny. Derfor er det en god ide at gemme den et sikkert sted. Hvis man har lavet en lang række af løsninger, der arbejder op imod API'et, vil de løsninger bruge API'et. Derfor er det ikke hensigtsmæssigt at trække et nyt token, hvis man har glemt sit nuværende.
5. Token
Sørg for aldrig at dele denne token med parter, som ikke er relevante. Denne token har en kritisk sikkerhedsmæssig funktion og kan i værste fald blive misbrugt.
