Většina lidí vyplňuje formuláře v prohlížeči. Vývojáři ale formuláře zabudovávají do vlastních aplikací, mobilních aplikací, vestavěných systémů a interních nástrojů. Tyto formuláře nepoužívají tvůrce formulářů s přetahováním. Data odesílají přímo na vaši platformu pro formuláře přes API.
Tento článek ukazuje, jak API formulářů fungují, kdy je potřebujete a na co se zaměřit u platformy pro formuláře s kvalitním přístupem k API.
Co je API formulářů a proč ho vývojáři používají
API formulářů je způsob, jak mohou vývojáři odesílat data formulářů programově, ne přes formulář v prohlížeči. Místo toho, aby někdo klikl na tlačítko „odeslat“ na webovém formuláři, vývojář napíše kód, který data posílá přímo do systému formulářů.
Kdy to uděláte?
Tvorba vlastní aplikace: Vytváříte vlastní aplikaci a chcete data formulářů sbírat tak, že váš nástroj pro formuláře slouží jako backend. Váš kód volá API formulářů pro odeslání.
Odesílání formulářů z mobilní aplikace: Máte mobilní aplikaci s formulářem. Když uživatelé odešlou data, kód aplikace zavolá API formulářů.
Integrace dat z více zdrojů: Sbíráte data z různých systémů a chcete, aby všechna šla na jednu platformu pro formuláře. Váš integrační kód používá API formulářů.
Dávkové operace: Máte tisíce záznamů, které chcete importovat. Místo ručního zadávání je váš kód odešle programově přes API formulářů.
Jak API formulářů fungují (bez nutnosti rozumět kódu)
API formulářů funguje takto: Vaše aplikace má data. Chce je odeslat na platformu pro formuláře. Provede volání API (představte si to jako zprávu), které říká „tady jsou nějaká data, prosím uložte je“. Platforma pro formuláře je přijme, ověří a uloží stejně, jako kdyby někdo vyplnil webový formulář a kliknul na odeslat.
Platforma pro formuláře vrátí odpověď, která potvrdí, že odeslání bylo přijato a uloženo.
Z pohledu platformy jsou data z odeslání přes API totožná s daty z odeslání webového formuláře. Obojí se zpracovává stejně.
Ověřování a zabezpečení API
Když váš kód volá API formulářů, musí prokázat, že je oprávněný. To se děje ověřováním, obvykle pomocí klíče API.
Klíč API je jako heslo pro vaši aplikaci. Držíte ho v tajnosti. Když váš kód chce odeslat data, klíč API připojí. Platforma pro formuláře klíč zkontroluje a řekne „ano, tato aplikace je oprávněná“.
Klíč API nikdy nezveřejňujte ve veřejném kódu ani ho nesdílejte. Pokud ho někdo získá, může vaším jménem odesílat data formulářů (což může být problém, pokud odeslané formuláře používáte pro zásadní obchodní rozhodnutí).
Omezení četnosti: kolik volání API je povoleno
Většina platforem pro formuláře omezuje, kolik volání API můžete provést. Zabraňuje to zneužití a chrání systém.
Typický limit může být „1 000 volání API za hodinu na klíč API“. Pokud vaše aplikace provede víc volání, než je limit, další volání se odmítnou, dokud se hodina neobnoví.
Při výběru platformy pro formuláře zkontrolujte limity API. Pokud potřebujete provést 10 000 odeslání za hodinu, limit 1 000 volání za hodinu vám nebude stačit. Zeptejte se platformy na vyšší limity nebo možnosti navýšení.
Odpovědi API a zpracování chyb
Když váš kód zavolá API formulářů, dostane odpověď. Ta říká, zda odeslání uspělo, nebo selhalo.
Úspěšná odpověď: HTTP 200 nebo 201. Odeslání bylo přijato a uloženo. Váš kód může pokračovat.
Odpověď s chybou: HTTP 400, 401, 500 a podobně. Něco se pokazilo. Váš kód by měl chybu zpracovat (zkusit znovu, zaznamenat ji, upozornit někoho).
Dobré chybové zprávy API říkají, co se pokazilo. „Chybí povinné pole: email“ je užitečné. „Chyba“ bez podrobností není.
Dávkové odesílání přes API
Někdy potřebujete odeslat více záznamů najednou. Některá API podporují dávkové operace: pošlete 100 odeslání jedním voláním API místo 100 samostatných volání.
Dávkové odesílání je efektivnější. Snižuje počet volání API a dokončí se rychleji.
Zkontrolujte, zda API vaší platformy pro formuláře dávkové odesílání podporuje. Pokud potřebujete importovat velké objemy dat, na této funkci záleží.
Upozornění přes webhook z pohledu API
Když data přicházejí přes API, můžete chtít upozornění nebo navazující akce. Některé platformy pro formuláře posílají upozornění přes webhook i u odeslání přes API, stejně jako u odeslání webových formulářů.
To znamená, že když váš kód odesílá přes API, vaše navazující systémy (CRM, e-mail a další) se stále dozvědí automaticky.
Dokumentace API a zkušenost vývojáře
Dobré API formulářů má výbornou dokumentaci. Vysvětluje, jak se ověřit, jaký koncový bod volat, jaký formát dat použít, jaké chyby můžete dostat, a obsahuje ukázky kódu.
Špatná dokumentace API dělá vývojářům život těžkým. Pokud vybíráte platformu pro formuláře a potřebujete přístup k API, přečtěte si nejdřív její dokumentaci. Je jasná? Jsou tam ukázky? Rozumíte jí?
Kdy použít API a kdy webové formuláře
Použijte webový formulář, když: Chcete, aby návštěvníci vyplnili formulář ve svém prohlížeči. Nepotřebujete kód. Stačí rozhraní tvůrce formulářů s přetahováním.
Použijte API, když: Jste vývojář, který vytváří vlastní aplikaci. Potřebujete odesílat data programově. Integrujete více zdrojů dat. Potřebujete přizpůsobit celý průběh odeslání.
Často používáte obojí. Web má webové formuláře pro návštěvníky. Vaše interní aplikace používá API pro programová odeslání.
Jak WEMASY podporuje API formulářů
WEMASY má API, přes které mohou vývojáři odesílat data formulářů programově. Dokumentaci k API a podrobnosti o přístupu najdete ve svém účtu WEMASY nebo na ceníku.