API-dataaflevering
Formål:
Artiklen har til formål at forklare de forskellige muligheder ved opsætning af API-kald gennem XFlow's API dataaflevering. Artiklen vil gennemgå alle vigtige indstillinger, samt hvordan værdier kan mappes fra felt-værdier.
Sidst redigeret: 05/02-2025
Indholdsfortegnelse:
1. Opsætning af API dataafleveringer
2. Vejledning: Opsætning af API-kald
2.1. Generelle indstillinger
2.2. Autentifikation
2.3. Konfiguration
2.4. Input
2.5. Output
1. Opsætning af API-dataaflevering
Et API (Application Programming Interface) er en programmeringsgrænseflade, der muliggør dataoverførsel mellem XFlow og jeres organisation. Via API'et kan I sende eller hente data til/fra en blanket til jeres eksterne ESDH-system.
Eksempelvis kan I hente data fra en udfyldelse, såsom navn og svar på diverse spørgsmål, og direkte ind i jeres system – eller omvendt. API dataaflevering giver jer også mulighed for integration med eksterne systemer. Ved at sende et request til et eksternt system kan I modtage information som Output. Disse data kan anvendes i andre dataafleveringer eller indføres som værdier i blanketten. På denne måde kan I nemt og effektivt udveksle data og optimere jeres arbejdsprocesser.
API dataaflevering muliggør både afsendelse og modtagelse af data fra alle felter i blanketterne. Ydermere giver det også mulighed for at sende en PDF-fil, der indeholder blanketten samt alle dokumenter relateret til en given arbejdsgang.
2. Vejledning: Opsætning af API-kald
Du opretter og redigerer nye API-dataafleveringer under menupunktet “dataafleveringer”, som du finder i venstre side af XFlow.
Tryk på API for at oprette en ny.
Når du har oprettet en ny API, bliver du mødt af flere valgmulgiheder. Under afsnittet “Generelt” i opsætning af en ny API skal du indsætte følgende:
Navn og beskrivelse: Navn og beskrivelse af API-dataafleveringen.
Aktiv: Dette bestemmer, om API-dataafleveringen kan findes i opsætningen af dataafleveringer i flowdesigneren. Hvis en dataaflevering allerede gør brug af opsætningen, vil dataafleveringen stadigvæk fungere, selvom opsætningen står om ‘ikke aktiv’.
2.1. Generelle indstillinger
URL: Link til det endpoint som der skal gøres brug af. 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.
Generelle indstillinger udfyldes her
Autentifikation omfatter
Brugernavn og password: Kan bruges som autentifikation til API-kaldet. Man skal være opmærksom på, at adgangskoden kun kan ses en gang.
Bearer Tokens: Dette bruges 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.2. Autentifikation
I API-dataafleveringen gøres der brug af et HTTP Request med en JSON/XML Body.
Denne JSON/XML skabelon/Body er definerbar, men I XFlow er det muligt at autogenerere den (Kun JSON). Det forventes dog, at den autogenererede JSON Body gennemlæses og tilpasses anvendte endpoint.
2.3. Konfiguration
Dette ser sådan her ud
Feltnavn: Dette bruges til at adskille mappings i dataafleveringens opsætningen
Type: Disse begrænser, hvilke felter som kan vælges imellem.
Flettefelt: Dette bruges til at mappe værdier fra API-dataafleveringen ind i den JSON Body, som bruges til API kaldet.
2.4. Input
Input felter kan bruges til at give blanketspecifikke oplysninger til API-kaldet. Man indsætter variabler i felterne “Skabelon” og “URL” på siden under konfiguration i XFlow. For at mappe variabler skal du bruge @@MinInputVariabel i URL, og i skabelonen bruger man JSON-request body {“EtFeltFraBlanket”:”@@MitInputFelt”}.
Efter man har indsat variablerne i disse felter, kan de bruges i mappings til dataafleveringer.
Tilføj nye felter her
Feltnavn: Disse bruges til at mappe værdier, som eventuelt kommer tilbage fra et API-kald. Disse værdier kan være case-sensitive.
Hvis et response returnerer en Body som denne: {fornavn: “Gert”} vil feltnavnet skulle være ‘fornavn’.
Type: Disse begrænser, hvilke felter som kan vælges i opsætning i flowdesigneren.
2.5. Output
Output felter kan bruges til at hente værdier fra JSON/XML-response, der bliver genereret af API-kaldet. For eksempel, en JSON-streng i form af {“MitFelt”:”MinFeltVærdi”} kan læses som en output-variabel med feltnavn “MitFelt” med typen “String” og med et “Flettefelt” navn, som man selv kan definere i XFlow. Felterne kan derefter bruges i mappings til dataafleveringer.
Tilføj nye output-felter
