Generelt
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 osv. Nederst i artiklen er der vedhæftet dokumentation for API'et.
Test af opsætning
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.
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. Det er kun systemadministratorer, der kan ændre og trække i nye tokens for organisationen.
Sådan tilgåes API'et på administrationssiden
Tryk på "API Brugerimport" i menuen i venstre side under "Organisation".
Når der er trykket på menupunktet vises denne side, hvis der ikke er sat et API op for organisationen:
Hvis der på organisationen er opsat et API, vil siden se sådan ud:
Husk på at dette ikke er ensbetydende med, at API'et er opsat på serveren.
For at tjekke, at API'et fungerer, gøres følgende:
Kopier URL'en og tilgå den i browseren:
Når denne grønne side vises, ses de forskellige endpoints og derved dokumentationen til API'et:
Hvis den grønne side ikke fremgår, kan du kontakte XFlow for yderlige information.
Token
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.
Advarsel
Sørg for aldrig at dele denne token med parter, som ikke er relevante. Denne token har en kritisk sikkerhedsmæssig funktion. I værste fald kan den misbruges i de forkerte hænder.
Udvikling
API'et understøtter kun Application/Json format. Headers skal se ud som følgende:
Dokumentation på endpoints
Ved at trykke på hvert endpoint kan mulighederne og kravene ses. Hvis API'et ikke er opsat, kan du se dokumentationen i PDF'en sidst i artiklen. Har du spørgsmål omhandlende funktionalitet, skal du være velkommen til at kontakte XFlow.
