De flesta fyller i formulär i en webbläsare. Men utvecklare bygger in formulär i egna applikationer, mobilappar, inbyggda system och interna verktyg. Dessa formulär använder inte formulärbyggarens dra-och-släpp. De använder API:er för att skicka data direkt till din formulärplattform.
Den här artikeln går igenom hur formulär-API:er fungerar, när du behöver dem och vad du bör leta efter hos en formulärplattform med bra API-åtkomst.
Vad ett formulär-API är och varför utvecklare använder dem
Ett formulär-API är ett sätt för utvecklare att skicka formulärdata programmatiskt i stället för via ett formulär i webbläsaren. I stället för att någon klickar på en "skicka"-knapp i ett webbformulär skriver en utvecklare kod som skickar data direkt till formulärsystemet.
När gör man så här?
När du bygger en egen applikation: Du bygger din egen app och vill samla in formulärdata med ditt formulärverktyg som backend. Din kod anropar formulär-API:t för att skicka.
Formulär i en mobilapp: Du har en mobilapp med ett formulär. När användarna skickar anropar appens kod formulär-API:t.
När du för samman data från flera källor: Du samlar in data från olika system och vill att allt ska gå till en formulärplattform. Din integrationskod använder formulär-API:t.
Batchåtgärder: Du har tusentals poster som du vill importera. I stället för att skriva in dem manuellt använder din kod formulär-API:t för att skicka dem programmatiskt.
Så fungerar formulär-API:er (utan att du behöver förstå kod)
Ett formulär-API fungerar så här: din applikation har data. Den vill skicka den datan till formulärplattformen. Den gör ett API-anrop (tänk på det som ett meddelande) som säger "här är lite data, spara den". Formulärplattformen tar emot den, validerar den och lagrar den precis som om någon hade fyllt i ett webbformulär och klickat på skicka.
Formulärplattformen skickar tillbaka ett svar som bekräftar att inskicket mottagits och lagrats.
Ur formulärplattformens perspektiv är data från ett API-inskick identisk med data från ett inskick via webbformulär. Båda behandlas lika.
API-autentisering och säkerhet
När din kod anropar ett formulär-API måste den bevisa att den är behörig. Det görs genom autentisering, oftast med en API-nyckel.
En API-nyckel är som ett lösenord för din applikation. Du håller den hemlig. När din kod vill skicka data bifogar den API-nyckeln. Formulärplattformen kontrollerar nyckeln och säger "ja, den här applikationen är behörig".
Publicera aldrig din API-nyckel i offentlig kod och dela den inte. Om någon får tag på din nyckel kan hen skicka formulärdata å dina vägnar (vilket kan bli ett problem om du använder formulärsvar till affärskritiska beslut).
Hastighetsbegränsning: hur många API-anrop som är tillåtna
De flesta formulärplattformar begränsar hur många API-anrop du kan göra. Det förhindrar missbruk och skyddar systemet.
En typisk gräns kan vara "1 000 API-anrop per timme och API-nyckel". Om din applikation gör fler anrop än gränsen avvisas efterföljande anrop tills timmen nollställs.
När du väljer formulärplattform ska du kontrollera gränserna för API-anrop. Om du behöver göra 10 000 inskick per timme fungerar inte en gräns på 1 000 anrop per timme. Fråga plattformen om högre gränser eller möjligheter att skala upp.
API-svar och felhantering
När din kod anropar formulär-API:t får den ett svar. Svaret talar om om inskicket lyckades eller misslyckades.
Svar vid lyckat anrop: HTTP 200 eller 201. Inskicket togs emot och lagrades. Din kod kan gå vidare.
Svar vid fel: HTTP 400, 401, 500 och så vidare. Något gick fel. Din kod bör hantera felet (försöka igen, logga det, larma någon).
Bra API-felmeddelanden talar om vad som gick fel. "Missing required field: email" är till hjälp. "Error" utan detaljer är det inte.
Batchinskick via API
Ibland har du flera inskick att göra samtidigt. Vissa API:er stöder batchåtgärder: du skickar 100 inskick i ett enda API-anrop i stället för att göra 100 separata anrop.
Batchinskick är effektivare. De minskar antalet API-anrop och går snabbare.
Kontrollera om din formulärplattforms API stöder batchinskick. Om du behöver importera stora datamängder är den funktionen viktig.
Webhook-notiser ur API-perspektiv
När data kommer in via API vill du kanske ha notiser eller uppföljande åtgärder. Vissa formulärplattformar skickar webhook-notiser för API-inskick precis som för inskick via webbformulär.
Det betyder att om din kod skickar via API får dina efterföljande system (CRM, e-post och liknande) ändå besked automatiskt.
API-dokumentation och utvecklarupplevelse
Ett bra formulär-API har utmärkt dokumentation. Den förklarar hur man autentiserar, vilken slutpunkt man anropar, vilket dataformat man använder, vilka fel man kan få och innehåller kodexempel.
Dålig API-dokumentation gör livet eländigt för utvecklare. Om du väljer en formulärplattform och behöver API-åtkomst ska du läsa deras API-dokumentation först. Är den tydlig? Finns det exempel? Förstår du den?
När du använder API och när du använder webbformulär
Använd ett webbformulär när: du vill att besökare ska fylla i ett formulär i sin webbläsare. Du behöver ingen kod. Formulärbyggarens dra-och-släpp räcker.
Använd ett API när: du är en utvecklare som bygger en egen applikation. Du behöver skicka data programmatiskt. Du för samman flera datakällor. Du behöver anpassa hela inskicksupplevelsen.
Ofta använder du båda. En webbplats har webbformulär för besökare. Din interna applikation använder API:t för programmatiska inskick.
Så stöder WEMASY formulär-API:er
WEMASY har ett REST API som låter utvecklare skicka formulärdata programmatiskt. Autentisera med en API-nyckel, skicka data till slutpunkten och få en bekräftelse. API-inskick behandlas på samma sätt som inskick via webbformulär. De startar automationer, synkas till kopplade system och syns i din WEMASY-panel. Hastighetsgränser och batchinskick finns beroende på ditt abonnemang. Se API-dokumentationen i ditt WEMASY-konto eller läs på prissidan för information om API-åtkomst.