Introduktion til: API-feltet
Formål:
Formålet med denne artikel er 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.
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.
Webinar: Lynkursus, API fra A-Z
video: https://vimeo.com/877989786
Webinar: API-feltet i XFlow
video: https://vimeo.com/878168097
Sidst redigeret: 14/02-2025
Indholdsfortegnelse:
1.1. Brugerdefineret fejlbesked
1.2. Debug mode
1.3. Stopklods
2.1. Fast værdi
2.2. Felt værdi
2.3. Validering af input
2.4. Input/Output
1. Vigtige indstillinger
I det følgende gennemgås tre indstillinger, som er vigtige i opsætningen af API-feltet i XFlow.
Vigtige indstillinger i opsætningen af API-feltet
1.1. Brugerdefineret fejlbesked
Denne besked vises til brugeren, hvis API-kaldet fejler, dvs. hvis kaldet ikke returnerer HTTP-statuskode 200.
1.2. 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.
1.3. Stopklods
Hvis kaldet fejler, vil dette stoppe muligheden for at indsende blanketten.
2. Opsætning af input og output felter
Som kendt fra opsætningen af API-feltet under dataafleveringer er der både input-værdier og output-værdier. I det følgende præsenteres de forskellige indstillinger for både input-og output-variablene
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.
2.1. Fast værdi
Funktionen Fast værdi kan både anvendes under input-og output-værdier
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. Her vælges det, hvilken blanket, hvilket felt og hvilken værdi, som feltet skal opdateres fra.
2.2. Felt værdi
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.3. Validering af input
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.