De fleste udfylder formularer i en browser. Men udviklere bygger formularer ind i egne applikationer, mobilapps, indlejrede systemer og interne værktøjer. De formularer bruger ikke formularbyggeren med træk og slip. De bruger API'er til at sende data direkte til din formularplatform.
Her ser vi på, hvordan formular-API'er virker, hvornår du har brug for dem, og hvad du skal kigge efter hos en formularplatform med solid API-adgang.
Hvad et formular-API er, og hvorfor udviklere bruger det
Et formular-API er en måde, hvorpå udviklere kan sende formulardata med kode i stedet for gennem en formular i en browser. I stedet for at nogen klikker på en "send"-knap i en webformular, skriver en udvikler kode, der sender data direkte til formularsystemet.
Hvornår gør man det?
Når du bygger en egen applikation: Du bygger din egen app og vil samle formulardata med dit formularværktøj som bagsystem. Din kode kalder formular-API'et for at sende.
Formular i en mobilapp: Du har en mobilapp med en formular. Når brugerne sender, kalder appens kode formular-API'et.
Når du samler data fra flere kilder: Du samler data fra forskellige systemer og vil have det hele til én formularplatform. Din integrationskode bruger formular-API'et.
Masseimport: Du har tusindvis af poster, du vil importere. I stedet for at skrive dem ind i hånden bruger din kode formular-API'et til at sende dem med kode.
Sådan virker formular-API'er (uden at du skal forstå kode)
Et formular-API virker sådan: Din applikation har data. Den vil sende dem til formularplatformen. Den laver et API-kald (tænk på det som en besked), der siger "her er nogle data, gem dem". Formularplatformen modtager dem, tjekker dem og gemmer dem, ligesom hvis nogen havde udfyldt en webformular og klikket på send.
Formularplatformen sender et svar tilbage, der bekræfter, at indsendelsen er modtaget og gemt.
Set fra formularplatformens side er data fra en API-indsendelse helt de samme som data fra en webformular. De behandles ens.
Godkendelse og sikkerhed i API'et
Når din kode kalder et formular-API, skal den bevise, at den har lov. Det sker med godkendelse, som regel en API-nøgle.
En API-nøgle er som en adgangskode til din applikation. Du holder den hemmelig. Når din kode vil sende data, tager den API-nøglen med. Formularplatformen tjekker nøglen og siger "ja, den her applikation har lov".
Udgiv aldrig din API-nøgle i offentlig kode, og del den ikke. Hvis nogen får fat i din nøgle, kan de sende formulardata i dit navn (det kan være et problem, hvis du bruger indsendelser til vigtige beslutninger i din virksomhed).
Begrænsning af antal kald: hvor mange API-kald er tilladt
De fleste formularplatforme begrænser, hvor mange API-kald du kan lave. Det forhindrer misbrug og beskytter systemet.
En typisk grænse kan være "1.000 API-kald i timen pr. API-nøgle". Laver din applikation flere kald end grænsen, bliver de næste kald afvist, til timen er gået.
Når du vælger formularplatform, så tjek grænserne for API-kald. Skal du sende 10.000 indsendelser i timen, virker en grænse på 1.000 kald i timen ikke for dig. Spørg platformen om højere grænser eller muligheder for at skalere.
Svar fra API'et og håndtering af fejl
Når din kode kalder formular-API'et, får den et svar. Svaret fortæller, om indsendelsen lykkedes eller fejlede.
Svar ved succes: HTTP 200 eller 201. Indsendelsen er modtaget og gemt. Din kode kan fortsætte.
Svar ved fejl: HTTP 400, 401, 500 og så videre. Noget gik galt. Din kode bør håndtere fejlen (prøve igen, logge den, give nogen besked).
Gode fejlbeskeder fra API'et fortæller, hvad der gik galt. "Manglende obligatorisk felt: e-mail" hjælper. "Fejl" uden detaljer gør ikke.
Masseindsendelser via API
Nogle gange har du flere indsendelser, der skal sendes på én gang. Nogle API'er understøtter masseindsendelser: Du sender 100 indsendelser i ét API-kald i stedet for at lave 100 separate kald.
Masseindsendelser er mere effektive. De mindsker antallet af API-kald og går hurtigere.
Tjek, om din formularplatforms API understøtter masseindsendelser. Skal du importere store mængder data, har den funktion betydning.
Webhook-beskeder set fra API'ets side
Når data kommer ind via API, vil du måske have beskeder eller opfølgende handlinger. Nogle formularplatforme sender webhook-beskeder for API-indsendelser, ligesom de gør for indsendelser fra webformularer.
Det betyder, at hvis din kode sender via API, får dine systemer længere nede (CRM, e-mail og så videre) stadig automatisk besked.
Dokumentation af API'et og udvikleroplevelsen
Et godt formular-API har fremragende dokumentation. Den forklarer, hvordan du godkender, hvilket endpoint du skal kalde, hvilket dataformat du skal bruge, hvilke fejl du kan få, og har eksempler på kode.
Dårlig dokumentation gør udviklerens liv surt. Hvis du vælger en formularplatform og har brug for API-adgang, så læs deres dokumentation først. Er den tydelig? Er der eksempler? Kan du forstå den?
Hvornår du bruger API, og hvornår du bruger webformularer
Brug en webformular, når: Du vil have besøgende til at udfylde en formular i deres browser. Du har ikke brug for kode. Formularbyggerens træk og slip er nok.
Brug et API, når: Du er udvikler og bygger en egen applikation. Du skal sende data med kode. Du samler flere datakilder. Du vil tilpasse hele oplevelsen af at sende.
Ofte bruger du begge dele. En hjemmeside har webformularer til besøgende. Din interne applikation bruger API'et til indsendelser med kode.
Sådan understøtter WEMASY formular-API'er
WEMASY har et REST API, der lader udviklere sende formulardata med kode. Godkend med en API-nøgle, send data til endpointet og få en bekræftelse. API-indsendelser behandles på samme måde som indsendelser fra webformularer. De starter automatiseringer, synkroniseres til tilsluttede systemer og vises i dit WEMASY-overblik. Grænser for kald og masseindsendelser afhænger af din plan. Se API-dokumentationen i din WEMASY-konto, eller tjek siden Priser for detaljer om API-adgang.