Większość ludzi wypełnia formularze w przeglądarce. Ale programiści wbudowują formularze we własne aplikacje, aplikacje mobilne, systemy wbudowane i narzędzia wewnętrzne. Takie formularze nie korzystają z kreatora z przeciąganiem i upuszczaniem. Używają API, by wysyłać dane bezpośrednio do platformy formularzy.
Ten artykuł wyjaśnia, jak działają API formularzy, kiedy ich potrzebujesz i na co zwrócić uwagę w platformie formularzy z solidnym dostępem do API.
Czym jest API formularza i dlaczego programiści z niego korzystają
API formularza to sposób, w jaki programiści wysyłają dane formularza programistycznie, a nie przez formularz w przeglądarce. Zamiast klikać przycisk „wyślij” w formularzu na stronie, programista pisze kod, który wysyła dane bezpośrednio do systemu formularzy.
Kiedy tak się robi?
Budowa własnej aplikacji: Tworzysz własną aplikację i chcesz zbierać dane formularza, używając narzędzia do formularzy jako zaplecza. Twój kod wywołuje API formularza, by wysłać dane.
Wysyłanie formularza z aplikacji mobilnej: Masz aplikację mobilną z formularzem. Gdy użytkownicy go wysyłają, kod aplikacji wywołuje API formularza.
Integracja danych z wielu źródeł: Zbierasz dane z różnych systemów i chcesz, by wszystkie trafiały na jedną platformę formularzy. Twój kod integracji używa API formularza.
Operacje wsadowe: Masz tysiące rekordów do zaimportowania. Zamiast wpisywać je ręcznie, Twój kod używa API formularza, by wysłać je programistycznie.
Jak działają API formularzy (bez konieczności rozumienia kodu)
API formularza działa tak: Twoja aplikacja ma dane. Chce wysłać je do platformy formularzy. Wykonuje wywołanie API (pomyśl o nim jak o wiadomości), które mówi: „oto dane, proszę je zapisać”. Platforma formularzy je odbiera, waliduje i zapisuje tak samo, jakby ktoś wypełnił formularz na stronie i kliknął wyślij.
Platforma formularzy zwraca odpowiedź potwierdzającą, że zgłoszenie zostało odebrane i zapisane.
Z perspektywy platformy formularzy dane z API są identyczne z danymi z formularza na stronie. Oba rodzaje są traktowane jednakowo.
Uwierzytelnianie i bezpieczeństwo API
Gdy Twój kod wywołuje API formularza, musi udowodnić, że ma uprawnienia. Robi się to przez uwierzytelnianie, zwykle za pomocą klucza API.
Klucz API to jak hasło dla Twojej aplikacji. Trzymasz go w tajemnicy. Gdy kod chce wysłać dane, dołącza klucz API. Platforma formularzy sprawdza klucz i stwierdza: „tak, ta aplikacja ma uprawnienia”.
Nigdy nie publikuj klucza API w publicznym kodzie ani nie udostępniaj go innym. Jeśli ktoś zdobędzie Twój klucz, może wysyłać dane formularza w Twoim imieniu (co może być problemem, jeśli zgłoszenia służą do kluczowych decyzji biznesowych).
Limity zapytań: ile wywołań API jest dozwolonych
Większość platform formularzy ogranicza liczbę wywołań API. Zapobiega to nadużyciom i chroni system.
Typowy limit to „1000 wywołań API na godzinę na klucz API”. Jeśli aplikacja wykona więcej wywołań niż limit, kolejne są odrzucane do końca godziny.
Wybierając platformę formularzy, sprawdź limity API. Jeśli potrzebujesz 10 000 zgłoszeń na godzinę, limit 1000 wywołań na godzinę nie wystarczy. Zapytaj platformę o wyższe limity lub opcje skalowania.
Odpowiedzi API i obsługa błędów
Gdy kod wywołuje API formularza, dostaje odpowiedź. Mówi ona, czy zgłoszenie się powiodło, czy nie.
Odpowiedź sukcesu: HTTP 200 lub 201. Zgłoszenie zostało odebrane i zapisane. Kod może działać dalej.
Odpowiedź błędu: HTTP 400, 401, 500 itd. Coś poszło nie tak. Kod powinien obsłużyć błąd (ponowić próbę, zapisać go w logu, powiadomić kogoś).
Dobre komunikaty błędów API mówią, co poszło nie tak. „Brak wymaganego pola: email” jest pomocne. „Błąd” bez szczegółów nie jest.
Zgłoszenia wsadowe przez API
Czasem masz do wysłania wiele zgłoszeń naraz. Niektóre API obsługują operacje wsadowe: wysyłasz 100 zgłoszeń jednym wywołaniem zamiast 100 osobnych.
Zgłoszenia wsadowe są wydajniejsze. Zmniejszają liczbę wywołań API i kończą się szybciej.
Sprawdź, czy API Twojej platformy formularzy obsługuje zgłoszenia wsadowe. Jeśli musisz importować duże ilości danych, ta funkcja ma znaczenie.
Powiadomienia webhook z perspektywy API
Gdy dane przychodzą przez API, możesz chcieć powiadomień lub działań następczych. Niektóre platformy formularzy wysyłają powiadomienia webhook dla zgłoszeń przez API tak samo jak dla zgłoszeń z formularzy na stronie.
Oznacza to, że jeśli Twój kod wysyła dane przez API, systemy dalsze (CRM, e-mail itd.) nadal dostają powiadomienia automatycznie.
Dokumentacja API i wygoda pracy programisty
Dobre API formularza ma świetną dokumentację. Wyjaśnia, jak się uwierzytelnić, który punkt końcowy wywołać, jakiego formatu danych użyć, jakie błędy mogą się pojawić, i zawiera przykłady kodu.
Słaba dokumentacja API utrudnia życie programistom. Jeśli wybierasz platformę formularzy i potrzebujesz dostępu do API, najpierw przeczytaj jej dokumentację API. Czy jest jasna? Czy są przykłady? Czy ją rozumiesz?
Kiedy użyć API, a kiedy formularzy na stronie
Użyj formularza na stronie, gdy: chcesz, by odwiedzający wypełniali formularz w przeglądarce. Nie potrzebujesz kodu. Wystarczy interfejs kreatora formularzy z przeciąganiem i upuszczaniem.
Użyj API, gdy: jesteś programistą budującym własną aplikację. Musisz wysyłać dane programistycznie. Integrujesz wiele źródeł danych. Chcesz dostosować całe doświadczenie wysyłania.
Często używa się obu. Strona ma formularze dla odwiedzających. Wewnętrzna aplikacja używa API do zgłoszeń programistycznych.
Jak WEMASY obsługuje API formularzy
WEMASY udostępnia REST API, które pozwala programistom wysyłać dane formularzy programistycznie. Uwierzytelnij się kluczem API, wyślij dane do punktu końcowego i odbierz potwierdzenie. Zgłoszenia przez API są traktowane identycznie jak zgłoszenia z formularzy na stronie. Uruchamiają automatyzacje, synchronizują się ze zintegrowanymi systemami i pojawiają się w Twoim panelu WEMASY. Limity zapytań i zgłoszenia wsadowe są dostępne zależnie od planu. Dokumentację API znajdziesz na koncie WEMASY, a szczegóły dostępu do API na stronie z cennikiem.