Lomakesisällön täyttö rajapinnan kautta
- Atte Pihamäki
- Jenni Stén
Tämä on lisäpalvelu FormBoxissa, jos olette kiinnostuneet käyttöönotosta,
ottakaa yhteys asiakaspalveluumme support@formbox.fi.
Lomakesisältöä voidaan rajapinnan kautta populoida oletusarvoilla. Rajapinnan kautta voidaan noutaa eri taustajärjestelmistä lomakkeelle tunnistautuneen asiakkaan tietoja, ja palauttaa näitä lomakkeelle. Esitäytettyjä tietoja voivat olla esimerkiksi tiedot asiakkaan omistamasta tontista maanmittauslaitokselta tai kunnan/kaupungin taustajärjestelmiin tallennetut tiedot. Mahdollisuudet ovat liki rajattomat erityisesti mikäli toiminnallisuus yhdistetään integraatioalustaan, joka mahdollistaa tietojen noutamisen useista lähteistä ja niiden ehdollistamisen sääntöihin/logiikkaan.
Lisäpalvelu sisältää API endpointtien hallinnoimisen organisaation asetuksissa sekä tietyn endpointin aktivoimisen lomakkeelle lomakkeen ominaisuuksissa.
API endpointtien hallinta
Kun lisäpalvelu on otettu käyttöön, näette uuden vaihtoehdon organisaation Asetukset -näkymässä: API endpoints. Tämä avaa oman näkymän API endpointtien hallintaa varten. Näkymässä voit lisätä, muokata ja poistaa organisaation käytössä olevia endpointteja.
Uuden API-endpointin lisäämiseksi tulee syöttää seuraavat pakolliset tiedot:
Nimi | API endpointin/prosessin nimi. Käytä nimeä jolla endpointin tarkoituksen tunnistaa mahdollisimman hyvin. Tämä nimi näytetään lomakkeen ominaisuuksissa, missä endpointin käyttö ja lomakkeen sisällön populointi aktivoidaan lomakekohtaisesti. |
|---|---|
URL | API endpointin url-osoite |
HTTP Header key | Avaimen HTTP otsikon nimi, esimerkiksi “Authorization” |
HTTP Header value | API-avaimen arvo, esimerkiksi “ApiKey x…y” |
API endpointin ja lomakesisällön populoimisen aktivoiminen lomakkeelle
API endpointin ja lomakesisällön populoimisen aktivoiminen lomakkeelle tapahtuu Lomakkeet -näkymässä lomakkeen ominaisuuksissa. Tietoryhmän Lomake alta löytyy asetus Esitäytä oletusarvot rajapinnasta. Tämä pudotusvalikko listaa ne API endpointit, jotka organisaatioille on lisätty organisaation asetuksissa.
Oletusarvo asetukselle Esitäytä oletusarvot rajapinnasta on Ei yhteyttä. Rajapintahaun aktivoimiseksi valitse pudotusvalikosta haluamasi API endpoint ja tallenna.
Rajapintakutsu (API) lomakkeen latauksen yhteydessä
Lomakkeen latauksen yhteydessä rajapinnan kautta tehdään GET kutsu määritettyyn API endpointtiin. Kutsun HTTP headers osio sisältää seuraavat avain/arvoparit query parametreina:
orgIduserIdformIdlanguageCode
{
"userId": "support@formbox.fi",
"formId": "123",
"languageCode": "fi",
"extra": "Text from API"
}Rajapinnan kautta tehty kutsu onnistuessaan palauttaa JSON objektin, jonka sisältöä käytetään lomakkeen kysymysten täyttämiseen niiden ID-arvon mukaan. Palautuvan JSON objektin avulla voidaan täyttää kysymysten oletusarvoja sekä HTML-työkalun sisältöä.
Kysymysten oletusarvoja ja HTML-työkalun sisältöä voidaan täyttää määrittämällä palautettavan JSON objektin avain/arvopareiksi kysymyksen ID-arvon (avain) ja oletusarvo (arvo). Lomakkeen latauksen yhteydessä JSON objektin avain/arvoparit yhdistetään niitä vastaaviin kysymyksiin ja näytetään lomakkeella.
Kysymyksen oletusarvon sekä HTML-sisällön määrittäminen
{
"phone": "+358123456789",
"email": "support@formbox.fi",
"checkbox": [
"Alternative 1",
"Alternative 2"
],
"html": "<h2>Heading</h2><p>Paragraph</p><a href=\"https://consilia.fi/\" target=\"_blank\">Go to our home page</a>",
"lastUpdated": "10.3.2024"
}
Aiheeseen liittyvät artikkelit: