Addo Forms - API: Data Output fields – Addo Sign Support

Ved brug af formularer kan du indhente svar fra dine kunder til dit eget system til indhentning af data.

Ved hjælp af Addo Forms, har du mulighed for at indhente informationer fra dine kunder, og du bestemmer selv hvilke informationer som dine kunder skal indgive. De informationer som kunderne udfylder i formularen, kan du ved hjælp af "Data output fields" få overført til din egen applikation, ved hjælp af API. Nedenstående guide vil forklare hvad data output felter er, hvordan disse bruges samt henvise til vores generelle API dokumentation, hvori du kan finde mere information herom:

Data Output Fields
Hvad er Data Output Fields?
Hvordan bruges Data Output Fields?
API dokumentation

Hvad er Data Output Fields?

Med Data Output Fields kan du sende en forespørgsel ved brug af API'et om at returnere en specifik information fra en formular, hvor der er gjort brug af PDF-formattering.

PDF-formattering i Addo Sign gør at Addo aflæser redigerbare felter, hvorefter at der efter udfyldelse af en formular automatisk generes en PDF med inkorpokerede svar fra formularen. Ved brug af Data Output Fields vil API'et derefter trække den ønskede information fra datakilden, og returnere det til den forespørgende klient i form af en "response".

Data Output Fields er de variabler og værdier i responsen, som indeholder den eftersprugte information. Det kan f.eks være fra et spørgsmål der relatere sig til et tekstsvar på én linje, flere linjer, checkbokse eller radiobuttons. Ved at interagere med API er det vigtigt at forstå formattet og den information, som er tilgængelig i responsen, som findes i Addo Signs API dokumentation, således at den anvendes korrekt. Der henvises til API dokumentationen nederst i afsnittet, og udover i artiklen her, vil den beskriver normalt de tilgængelige parametre, samt hvilke værdier de kan indeholde og hvordan de skal anvendes.

Når du har oprettet alle de redigérbarefelter som du skal bruge i din PDF, har du mulighed for at indsætte din PDF-fil som formattering i din Addo Form. Du skal blot sætte fluehak i at du ønsker at benytte dig af et PDF-skema, uploade det og klikke på "Vis datafelter".

Sæt flueben i "PDF-skema"
Det er valgfrit, om du ønsker at fjerne den tilhørende PDF skema
Klik på drop-down menuen for at se de tilgængelige Data Output Fields

I denne forbindelse har du mulighed for at vise eller skjule datafelter. Som det fremgår i nedenstående skærmprint, kan du klikke på: "Vis dataoutputfelter" og herefter "Skjul dataoutputfelter" . Når der trykkes på "Skjul dataoutputfelter", vil datafelterne være skjult, og etiketten ændres til "Vis dataoutputfelter". Bemærk at de skjulte datafelter bevarer deres værdier:

Klik på "Vis datafelter"
Bemærk at der ved hver komponent vil opstå et data output ID, som kan vælges, hvilket fremgår på nedenstående skærmbillede:

På den måde kan du indhente indhente informationer omkring dine kunder og lagre data'en direkte i dit system. Tidligere bestod et komponent id ulæseligt, såsom: Id:36b83a24-95f7-ec11-9135-0050560730e1. Formålet med datafelter er at have en entydig identifikator for et komponent i Addo Forms, som er lettere at læse. Komponenterne er:

Tekstsvar på en enkelt linje
Tekstsvar på flere linjer
Radio buttons
Fil-upload
Dato

Med datafelter er det nu muligt at genkende hver identifikator, såsom "DataMappingID: Numeric Field 1". Eksempelvis, hvis DataMappingID fjernes og komponenten tilføjes igen, vil dette ID give ændringer, men DataMappingID (datafelter) forbliver det samme. Et eksempel herpå:

     {
            "DataMappingId": "Numeric Field 1",
            "Id": "36b83a24-95f7-ec11-9135-0050560730e1",
            "Label": "Lorem ipsum dolor.",
            "Locked": false,
            "Order": 4,
            "ParentId": "83b07c61-e0d5-ec11-9124-0050560733ee",
            "Required": false,
            "Type": 4,
            "Value": null
        },

Hvordan bruges Data Output Fields?

Parametrene tager udgangspunkt i en web service request /GetFormTemplate som er dokumenteret på vores API dokumentation under "Properties of respone types". Bemærk at ovenstående 39b83a24-95f7-ec11-9135-0050560730e1 ikke er en "signing", selvom det ligner en signing token. Det er en GUID (globally unique identifier). Når vi opretter en ny komponent i formularen, tildeles komponenten et GUID, f.eks. "Id:36b83a24-95f7-ec11-9135-0050560730e1", som beskrevet ovenfor. Et eksempel på GetFormTemplate:

Response from GetFormTemplate is:{
    "Components": [
        {
            "Id": "36b83a24-95f7-ec11-9135-0050560730e1",
            "Label":null,
            "Locked":false,
            "Order": 0,
            "ParentId":null,
            "Required":false,
            "Type": 1,
            "Value":null
        },
        {
            "Id": "39b83a24-95f7-ec11-9135-0050560730e1",
            "Label": "Please enter your name",
            "Locked":false,
            "Order": 2,
            "ParentId": "36b83a24-95f7-ec11-9135-0050560730e1",
            "Required":false,
            "Type": 2,
            "Value":null
        },
        {
            "Id": "bb2b710c-a6f7-ec11-9135-0050560730e1",
            "Label":null,
            "Locked":true,
            "Order": 0,
            "ParentId": "36b83a24-95f7-ec11-9135-0050560730e1",
            "Required":true,
            "Type": 2,
            "Value":null
        },
        {
            "Id": "bc2b710c-a6f7-ec11-9135-0050560730e1",
            "Label":null,
            "Locked":true,
            "Order": 1,
            "ParentId": "36b83a24-95f7-ec11-9135-0050560730e1",
            "Required":true,
            "Type": 2,
            "Value":null
        }
    ],
    "Id": "2602dadc-ca77-4bc2-b393-0f5436a108b5",
    "Name": "A simple form"
}

I ovenstående meget enkle formular, er det nemt at se, at hvis der et et ønske om at udfylde "Please enter your name" komponenten, skal komponenten slås op med ID 39b83a24-95f7-ec11-9135-0050560730e1 og sætte dens værdi til den ønskede værdi.

Bemærk:t "Please enter our name" fremgår som et "label" i API-kaldet

I en formular med flere komponenter vil det være mere kompliceret, men muligt, eksempelvis hvis komponenten ændres som vist her ("Please enter your name"-feltet fjernes og tilføjes igen):

Som tidligere nævnt, er det her, at det bliver mere kompliceret. Et eksempel herpå:

{
    "Components": [
        {
            "Id": "36b83a24-95f7-ec11-9135-0050560730e1",
            "Label":null,
            "Locked":false,
            "Order": 0,
            "ParentId":null,
            "Required":false,
            "Type": 1,
            "Value":null
        },
        {
            "Id": "393f7da9-a6f7-ec11-9135-0050560730e1",
            "Label":null,
            "Locked":true,
            "Order": 1,
            "ParentId": "36b83a24-95f7-ec11-9135-0050560730e1",
            "Required":true,
            "Type": 2,
            "Value":null
        },
        {
            "Id": "3a3f7da9-a6f7-ec11-9135-0050560730e1",
            "Label":null,
            "Locked":true,
            "Order": 0,
            "ParentId": "36b83a24-95f7-ec11-9135-0050560730e1",
            "Required":true,
            "Type": 2,
            "Value":null
        },
        {
            "Id": "3b3f7da9-a6f7-ec11-9135-0050560730e1",
            "Label": "Please enter your name",
            "Locked":false,
            "Order": 2,
            "ParentId": "36b83a24-95f7-ec11-9135-0050560730e1",
            "Required":false,
            "Type": 2,
            "Value":null
        }
    ],
    "Id": "2602dadc-ca77-4bc2-b393-0f5436a108b5",
    "Name": "A simple form"
}

Det er grundlæggende den samme komponent, der har en request om det samme. Men det interne Addo-ID er ændret til 3b3f7da9-a6f7-ec11-9135-0050560730e1, som ikke er optimalt. Et eksempel på en formular, hvor der tilføjes et "DataOutputID" til klassen FormComponentForView, ville formulardesigneren nogenlunde se sådan ud:

Det nye "DataOutputID"-felt er valgfrit. Det kan indeholde bogstaver, tal, "-" og "_". Når formularen sendes ved hjælp af /InitiateFormSigning, bør ComponentValueOverride udvides til at have en DataOutputID-egenskab. Hvis DataOutputID er indstillet, skal du bruge den, ellers skal du vende tilbage til at bruge Id. GetFormTemplate og GetFormResponse bør også udvides, så DataOutputID er til stede i svaret.

API dokumentation

For at skabe en forståelse af de forskellige parametre, såsom GetFormSigning eller InitiateFormSigning, henvises til vores API dokumenation, som findes her.