Opsætning af API (API-felt)
Med XFlows API-felt får du mulighed for at foretage API-kald i opsætningen af dine blanketskabeloner. Dette har til formål at effektivisere udfyldelsen af den endelige selvbetjeningsløsning.
Formål:
Formålet med denne artikel er at beskrive mulighederne for opsætning af API-kald gennem XFlow's API-felt. Artiklen vil gennemgå opsætningen af API-feltet, samt hvordan værdier kan mappes fra feltværdier. Dette gør det efterfølgende muligt, at anvende API-feltet i din organisations blanketskabeloner.
Ønsker du at vide mere om anvendelsen af API-feltet i opsætningen af dine blanketskabeloner, kan du læse en introduktion til anvendelsen af API-feltet her
Sidst redigeret: 22/03/2024
Indholdsfortegnelse:
2. Vejledning (Opsætning af API-kald)
2.1. Generelle indstillinger
2.2. Autentifikation
2.3. Konfiguration
2.3.1 Input
2.3.2 Output
1. Beskrivelse
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 udfyldes blanketten. Hvis du vil vide mere om vigtige indstillinger for API-feltet, når du anvender det i opsætningen af dine blanketskabeloner, kan du klikke her.
2. Vejledning (Opsætning af API-kald)
API-felter kan oprettes og redigeres under menupunktet "Dataafleveringer".
Åben menupunktet “Dataafleveringer”. Klik derefter på “Tilføj” i det øvre, højre hjørne og vælg derefter “API-Felt”
2.1. Generelle indstillinger
Det første, du skal gøre, når du tilføjer et API-felt, er at tage stilling til en række 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.2. Autentifikation
Det er muligt at skabe sikkerhed i kaldet til rest-api'et via brugernavn-Adgangskode eller via Bearer token. Du skal kun vælge en af mulighederne:
Brugernavn og Password - Angiv brugernavn og password til API’et
Bearer Token - Dette bruges, hvis der i kaldet bruges en Bearer Token som autentifikation til det 'rigtige' API-kald. Her skal du tage stilling til:
URL: Endpointet, hvor Bearer Token kan hentes
Body: Her skrives de credentials ind, som skal bruges til authentication
Dataformat: Json/XML
2.3. 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.
Json-Skabelon
2.3.1. Input
Input-felter kan bruges til at give blanket-specifikke oplysninger til API-kaldet. Variabler kan indsættes i felterne "Json-Skabelon" og "Url" under generelt i form af @@MinInputVariable. Felterne kan derefter opsættes i API-Feltet. I feltet "Json-Skabelon" ovenfor kan du derefter bruge følgende JSON-request body: {"EtFeltFraMinBlanket":"@@MitInputFelt"}
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.3.2. Output
Output-felter kan bruges til at hente værdier fra JSON-response, der genereres af API-kaldet. For eksempel en JSON-streng i form af {"MitFelt":"MinFeltVaerdi"} kan læses som en output variable med Feltnavn "MitFelt" med typen "String" og med et "Flettefelt" navn, som du selv kan definere. Felterne kan derefter bruges til opdatering af værdier i blanketten. Ved brug af children i den retunerede Json Body, kan de tilgåes med en kommasepareret liste
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.