Useimmat ihmiset täyttävät lomakkeita selaimessa. Kehittäjät kuitenkin rakentavat lomakkeita omiin sovelluksiin, mobiilisovelluksiin, sulautettuihin järjestelmiin ja sisäisiin työkaluihin. Nämä lomakkeet eivät käytä vedä ja pudota -lomakkeiden rakennustyökalua. Ne käyttävät rajapintoja, joilla tiedot lähetetään suoraan lomakealustallesi.
Tässä artikkelissa käydään läpi, miten lomakkeiden rajapinnat toimivat, milloin niitä tarvitaan ja mitä kannattaa katsoa lomakealustassa, jonka rajapintaan pääsee kunnolla.
Mikä lomakkeen rajapinta on ja miksi kehittäjät käyttävät sitä
Lomakkeen rajapinta on tapa, jolla kehittäjät lähettävät lomakkeen tiedot ohjelmallisesti selainlomakkeen sijaan. Sen sijaan että joku napsauttaa verkkolomakkeen "Lähetä"-painiketta, kehittäjä kirjoittaa koodin, joka lähettää tiedot suoraan lomakejärjestelmään.
Milloin näin tehdään?
Oman sovelluksen rakentaminen: Rakennat omaa sovellusta ja haluat kerätä lomaketietoja käyttäen lomaketyökaluasi taustajärjestelmänä. Koodisi kutsuu lomakkeen rajapintaa lähettääkseen tiedot.
Mobiilisovelluksen lomakkeen lähetys: Sinulla on mobiilisovellus, jossa on lomake. Kun käyttäjät lähettävät sen, sovelluksen koodi kutsuu lomakkeen rajapintaa.
Useiden lähteiden tietojen yhdistäminen: Keräät tietoja eri järjestelmistä ja haluat kaiken yhdelle lomakealustalle. Integraatiokoodisi käyttää lomakkeen rajapintaa.
Eräajot: Sinulla on tuhansia tietueita, jotka haluat tuoda. Sen sijaan että syöttäisit ne käsin, koodisi lähettää ne ohjelmallisesti lomakkeen rajapinnan kautta.
Miten lomakkeen rajapinnat toimivat (ilman koodin ymmärtämistä)
Lomakkeen rajapinta toimii näin: sovelluksellasi on tietoja. Se haluaa lähettää ne lomakealustalle. Se tekee rajapintakutsun (ajattele sitä viestinä), joka sanoo "tässä on tietoja, tallenna ne". Lomakealusta vastaanottaa ne, tarkistaa ne ja tallentaa ne samalla tavalla kuin jos joku olisi täyttänyt verkkolomakkeen ja napsauttanut lähetä.
Lomakealusta palauttaa vastauksen, joka vahvistaa, että lähetys vastaanotettiin ja tallennettiin.
Lomakealustan kannalta rajapinnan kautta tulevat tiedot ovat identtiset verkkolomakkeen lähetyksen tietojen kanssa. Molempia kohdellaan samalla tavalla.
Rajapinnan tunnistautuminen ja tietoturva
Kun koodisi kutsuu lomakkeen rajapintaa, sen täytyy todistaa, että sillä on lupa. Tämä tehdään tunnistautumisella, yleensä rajapinta-avaimella.
Rajapinta-avain on kuin sovelluksesi salasana. Pidät sen salassa. Kun koodisi haluaa lähettää tietoja, se liittää mukaan rajapinta-avaimen. Lomakealusta tarkistaa avaimen ja toteaa: "kyllä, tällä sovelluksella on lupa."
Älä koskaan julkaise rajapinta-avaintasi julkisessa koodissa äläkä jaa sitä. Jos joku saa avaimesi, hän voi lähettää lomaketietoja puolestasi (mikä voi olla ongelma, jos käytät lomakelähetyksiä liiketoiminnan kannalta kriittisiin päätöksiin).
Kutsujen rajoitus: kuinka monta rajapintakutsua sallitaan
Useimmat lomakealustat rajoittavat rajapintakutsujen määrää. Tämä estää väärinkäyttöä ja suojaa järjestelmää.
Tyypillinen raja voi olla "1 000 rajapintakutsua tunnissa rajapinta-avainta kohti". Jos sovelluksesi tekee enemmän kutsuja kuin raja sallii, seuraavat kutsut hylätään, kunnes tunti vaihtuu.
Kun valitset lomakealustaa, tarkista rajapinnan kutsurajat. Jos tarvitset 10 000 lähetystä tunnissa, 1 000 kutsun tuntiraja ei riitä. Kysy alustalta korkeammista rajoista tai skaalausvaihtoehdoista.
Rajapinnan vastaukset ja virheiden käsittely
Kun koodisi kutsuu lomakkeen rajapintaa, se saa vastauksen. Vastaus kertoo, onnistuiko vai epäonnistuiko lähetys.
Onnistumisvastaus: HTTP 200 tai 201. Lähetys vastaanotettiin ja tallennettiin. Koodisi voi jatkaa.
Virhevastaus: HTTP 400, 401, 500 jne. Jokin meni pieleen. Koodisi pitäisi käsitellä virhe (yrittää uudelleen, kirjata se lokiin, hälyttää jotakuta).
Hyvät rajapinnan virheilmoitukset kertovat, mikä meni pieleen. "Missing required field: email" on hyödyllinen. "Error" ilman tarkempia tietoja ei ole.
Eräkäsittely rajapinnan kautta
Joskus sinulla on useita lähetyksiä tehtävänä kerralla. Jotkin rajapinnat tukevat eräajoja: lähetät 100 lähetystä yhdellä rajapintakutsulla 100 erillisen kutsun sijaan.
Eräkäsittely on tehokkaampaa. Se vähentää rajapintakutsujen määrää ja valmistuu nopeammin.
Tarkista, tukeeko lomakealustasi rajapinta eräkäsittelyä. Jos sinun täytyy tuoda suuria tietomääriä, tällä ominaisuudella on väliä.
Webhook-ilmoitukset rajapinnan näkökulmasta
Kun tietoja tulee rajapinnan kautta, saatat haluta ilmoituksia tai jatkotoimia. Jotkin lomakealustat lähettävät webhook-ilmoituksia rajapintalähetyksistä aivan kuten verkkolomakkeen lähetyksistä.
Tämä tarkoittaa, että jos koodisi lähettää tietoja rajapinnan kautta, jatkojärjestelmäsi (asiakashallinta, sähköposti jne.) saavat silti ilmoituksen automaattisesti.
Rajapinnan dokumentaatio ja kehittäjäkokemus
Hyvässä lomakerajapinnassa on erinomainen dokumentaatio. Se kertoo, miten tunnistaudutaan, mitä päätepistettä kutsutaan, mitä tietomuotoa käytetään, millaisia virheitä voi tulla, ja sisältää koodiesimerkkejä.
Huono rajapinnan dokumentaatio tekee kehittäjän elämästä kurjaa. Jos valitset lomakealustaa ja tarvitset rajapintaa, lue ensin sen rajapinnan dokumentaatio. Onko se selkeä? Onko siinä esimerkkejä? Ymmärrätkö sen?
Milloin käyttää rajapintaa ja milloin verkkolomaketta
Käytä verkkolomaketta, kun: haluat kävijöiden täyttävän lomakkeen selaimessaan. Et tarvitse koodia. Lomakkeiden rakennustyökalun vedä ja pudota -käyttöliittymä riittää.
Käytä rajapintaa, kun: olet kehittäjä ja rakennat omaa sovellusta. Sinun täytyy lähettää tietoja ohjelmallisesti. Yhdistät useita tietolähteitä. Haluat mukauttaa koko lähetyskokemuksen.
Usein käytät molempia. Verkkosivustolla on verkkolomakkeet kävijöille. Sisäinen sovelluksesi käyttää rajapintaa ohjelmallisiin lähetyksiin.
Näin WEMASY tukee lomakkeiden rajapintoja
WEMASY tarjoaa REST-rajapinnan, jonka avulla kehittäjät voivat lähettää lomaketietoja ohjelmallisesti. Tunnistaudu rajapinta-avaimella, lähetä tiedot päätepisteeseen ja saat vahvistuksen. Rajapintalähetyksiä kohdellaan samoin kuin verkkolomakkeen lähetyksiä. Ne käynnistävät automaatiot, synkronoituvat yhdistettyihin järjestelmiin ja näkyvät WEMASY-hallintapaneelissasi. Kutsurajat ja eräkäsittely ovat saatavilla paketistasi riippuen. Katso rajapinnan dokumentaatio WEMASY-tililtäsi tai tarkista rajapinnan käyttöä koskevat tiedot hinnoittelusivulta.