REST-veld

Het REST-veld stelt je formulieren in staat om direct met externe webservices te communiceren. Door een REST-aanvraag (in JSON of XML) naar een externe API te versturen, kan het formulier dynamisch gegevens ophalen en het antwoord opslaan. Je kunt deze waarden vervolgens extraheren en weergeven met behulp van onze JSONVAL()- en XMLVAL()-formulefuncties.

🛑 Vereisten

• Actieve internetverbinding: Omdat dit veld live API-zoekopdrachten uitvoert, werkt het niet offline.
• Premium-licentie: Het REST-veld is een Premium-functie. Zorg ervoor dat je veldgebruikers een Premium-accountniveau hebben.

REST-veld vs. REST-formulierconnector

Hoewel beide functies verbinding maken met externe APIs, dienen ze verschillende UX-doeleinden:

Je REST-veld configureren

Sleep het REST-veld vanuit de linkertoolbalk naar je formuliercanvas en configureer vervolgens de volgende instellingen in het eigenschappenpaneel aan de rechterkant.

1. Verbindingsdetails

• Bestemmings-URL: De eindpunt-URL van de externe webservice. Je kunt de Formula Builder gebruiken om dit dynamisch in te stellen.
• REST-werkwoord: Selecteer GET, POST, PUT of DELETE.
• REST-indeling: Selecteer JSON (standaard) of XML, afhankelijk van je doel-API.

2. Payload en headers

• Aanvraagtekst: (Optioneel) Geef je JSON- of XML-payload op. Gebruik onze standaard Data Template-syntaxis om live veldwaarden of formulareresultaten in te voegen.
  JSON
  {
"MyJsonProperty": "{{myfieldvalue}}"
}
• Aanvraagheaders: (Optioneel) Geef sleutel-waardeparen voor headers op (bijv. verificatietokens). De Data Template-syntaxis wordt hier ook ondersteund.💡 Opmerking: Alle header- en tekstwaarden worden automatisch URL-gecodeerd (bijv. Value@#$% wordt Value%40%23%24%25).

3. Uitvoeringstriggers

Definieer exact wanneer de API-aanvraag moet worden geactiveerd:

• Bij formulierbelasting: Wordt geactiveerd op het moment dat de gebruiker het formulier opent.
• ⚠️ Kritieke regel: REST-velden ingesteld om Bij formulierbelasting uit te voeren, moeten op de allereerste pagina van je formulier worden geplaatst.
• Op voorwaarde: Wordt geactiveerd wanneer een specifieke formule als waar wordt geëvalueerd.
• Voorbeeld: Als je de voorwaarde instelt op NOTBLANK({{myActionField}}), wordt de API-aanvraag geactiveerd op het moment dat de gebruiker interactie heeft met myActionField.

4. Gebruikerservaring (UX)

• Dialoogbericht: Voer een aangepast bericht in (bijv. “Meest recente gegevens ophalen…”) om een laadoverlay aan de gebruiker weer te geven terwijl de API-aanvraag wordt uitgevoerd.

🚀 Tutorial: voorbeeld-app voor weerAPI

Om het REST-veld in actie te zien, kun je onze vooraf gemaakte voorbeeld-app voor weerinformatie rechtstreeks vanuit de Examples Catalog installeren. Deze app laat zien hoe je verbinding maakt met een weer-API, de locatie van een gebruiker doorgeeft en de JSONVAL()-formule gebruikt om weergegevens onmiddellijk op het scherm in te vullen.

Hoe je de voorbeeld-app configureert:

1. Verkrijg een API-sleutel: Registreer je voor een gratis account bij je voorkeurweergegevensprovider (bijv. Weatherstack of OpenWeatherMap) om een unieke API-sleutel te krijgen.
2. Werk het formulier bij: Open het voorbeeld-formulier in de builder en plak je API-sleutel in het verborgen veld met de naam apiKey.
3. Test het formulier: Publiceer en open het formulier op een mobiel apparaat. Selecteer een land in de vervolgkeuzelijst om het formulier live weergegevens zien ophalen en toewijzen.

📘 Diepgang: Ga naar onze Formula Cheat Sheet voor meer informatie over het parseren van API-payloads.

Installeer de app nu

Selecteer de link die overeenkomt met je gegevensresidency-serverknooppunt:

• Installeer op US-serverknooppunt
• Installeer op EU-serverknooppunt
• Installeer op AU-serverknooppunt