Opsætning af API-felt
Formål:
Denne artikel har to formål:
1) At give dig en grundlæggende forståelse af API-feltet og dets indstillinger samt give dig inspiration til, hvordan feltet kan benyttes i opbygningen af blanketter.
2) At forklare mulighederne for opsætning af API-kald gennem XFlow's API-felt. Artiklen vil gennemgå alle vigtige indstillinger, og hvordan værdier kan mappes fra feltværdier.
Sidst redigeret: 06/03-2025
Indholdsfortegnelse:
1.1. Vigtige indstillinger
1.2. Input/output
1.3. Fast værdi og felt værdi
1.4. Validering og input
2.1. Vejledning - opsætning af API-kald
2.2. Generelle indstillinger
2.3. Autentifikation
2.4. Konfiguration
2.5. Input
2.6. Output
API-felt i XFlow
API-feltet giver muligheden for at integrere med eksterne systemer uden at kræve flere trin i flowet. API-feltet kan sende et request til et eksternt system, hvor information, der eventuelt modtages, automatisk udfylder blanketten. API-feltet giver mulighed for at tage faste værdier eller værdier fra blanketter med i et API-kald, hvorefter de returnerede værdier fra kaldet kan indsættes i felter i blanketterne.
For at hjælpe dig godt i gang med at bruge API-feltet, tilbyder vi to webinarer, som du kan tilgå når som helst.
Lynkursus, API fra A-Z er for dig, som kender meget lidt til begrebet API.
Webinar, API-feltet i XFlow er for dig, som er klar til at sætte dit eget API-felt op.
Webinar
1. Introduktion til API-felt
API-feltet giver mulighed for at tage faste værdier eller værdier fra blanketter med i et API-kald, hvorefter de returnerede værdier fra kaldet kan indsættes i felter i blanketterne.
1.1. Vigtige indstillinger
Brugerdefineret fejlbesked:
Denne besked vises til brugeren, hvis API-kaldet fejler, dvs. hvis kaldet ikke returnerer HTTP-statuskode 200.
Debug Mode
Dette skal kun slås til i perioden, hvor feltet konfigureres. Det vil vise diverse oplysninger vedrørende API-kaldet, som kan hjælpe med opsætningen. Kun systemadministratorer og brugere med rettigheden "Anvend API-Felt" kan gøre brug af denne funktion.
Stopklods
Hvis kaldet fejler, vil dette stoppe muligheden for at indsende blanketten.
1.2. Input/output
Som kendt fra opsætningen af API-feltet under dataafleveringer er der både Input-værdier og Output-værdier. Ved input er alle de værdier, der skal bruges i API-kaldet. Disse oplysninger bliver automatisk flettet ind i den foruddefinerede JSON Body, der er opsat i API-feltet under Dataafleveringer.
Output-værdierne skaber muligheden for at tage informationer, som bliver returneret fra API-kaldet, og indsætte værdierne i felter i blanketten.
1.3. Fast værdi og felt værdi
Det er muligt at bruge en fast værdi både i Input og Output. Dette betyder, at der ikke gøres brug af en værdi fra et felt i blanketten. Dette giver mere fleksibilitet til at bruge samme API-felt opsætning på flere blanketskabeloner. Disse værdier kan også mappes ind i den URL, som bliver kaldt.
I et Input, der gør brug af en feltværdi, betyder det, at API-kaldet vil bruge værdien fra blanketten. Det er muligt at gøre brug af informationer over forskellige blanketskabeloner.
1.4. Validering af input
Hvis feltet, hvorfra informationen skal hentes, er påkrævet, er det muligt at køre en validering på feltet inden API-kaldet. Hvis valideringen fejler, vil API-kaldet ikke blive gennemført.
2. Opsætning af API (API-felt)
API-feltet giver muligheden for at integrere med eksterne systemer uden at kræve flere trin i flowet. API-feltet kan sende et request til et eksternt system, hvor information, der eventuelt modtages, automatisk udfylder blanketten.
2.1. Vejledning (Opsætning af API-kald)
API-felter kan oprettes og redigeres under menupunktet "Dataafleveringer", som du finder i menuen i venstre side.
Ved den røde pil finder du menupunktet “Dataafleveringer”
Klikker du på den grønne knap, “Tilføj”, i højre side, popper der en menu op, hvor du kan vælge “API-felt”.
Ved den røde pil finder du menupunktet “API-felt”
Når du har klikket på API-felt, får du mulighed for at oprette dit eget API-felt med navn og beskrivelse.
2.2. Generelle indstillinger
Navnet på API-feltet
Beskrivelse
Aktiv - Dette bestemmer, om API-feltet kan findes i opsætningen af felter. Hvis et felt allerede gør brug af opsætningen, vil feltet stadigvæk fungere, selvom opsætningen er markeret som 'ikke aktiv'.
URL - Link til det endpoint, som skal benyttes. Her er det muligt, ligesom ved JSON body, at flette værdier ind.
Metode - Her vælges mellem Post/Patch/Put/Get
Headers - Dette bruges til brugerdefinerede headers. Dette kan eksempelvis være en Key-nøgle.
2.3. Autentifikation
Brugernavn
Password
Bearer Token:
Dette bruges, hvis der i kaldet bruges en Bearer Token som autentifikation til det 'rigtige' API-kald.
URL - Endpointet, hvor Bearer Token kan hentes.
Body - her skrives de credentials ind, som skal bruges til authentication.
Dataformat - Json/XML
2.4. Konfiguration
I API-feltet gøres der brug af et HTTP Request med en JSON Body. Denne JSON-skabelon/Body er definerbar, men i XFlow er det muligt at autogenerere den. Det forventes dog, at den autogenererede JSON Body gennemlæses og tilpasses anvendte endpoint.
HTTP Request med en JSON Body
2.5. Input
Feltnavn - Dette bruges til at mappe op i API-feltet i blanketskabeloner.
Type - Disse begrænser, hvilke felter der kan vælges i opsætning på blanketskabeloner.
Flettefelt - Dette bruges til at mappe værdier fra API-feltet ind i den JSON Body, som bruges til API-kaldet. (Se vejledende tekst på opsætningssiden)
2.6. Output
Feltnavn - Disse bruges til at mappe værdier, som eventuelt kommer tilbage fra et API-kald, tilbage ind i en blanket. Disse værdier kan være case-sensitive.
Hvis et respons returnerer en Body som denne: {fornavn: “Gert”}, vil feltnavnet skulle være 'fornavn'.
Type - Disse begrænser, hvilke felter der kan vælges i opsætning på blanketskabeloner.
Nu har du fået en introduktion til API-feltet i XFlow, og hvis du har mod på mere, så kan du blot læse videre i artiklerne herunder:
