API & Webhooky

Na této stránce můžete nastavit přístup ke Click4Survey API a dále specifikovat Webhooky pro ještě bližší propojení Click4Survey s Vašimi aplikacemi.

Co je to API?

API neboli Application Programming Interface slouží pro komunikaci dvou nebo více systémů. V kontextu propojování informačních systémů nebo webových aplikací se používá pro standardizovanou komunikaci mezi dvěma systémy.

Co jsou to Webhooky?

Webhooky jsou zpětná volání (callbacky) protokolu HTTP. Protože webhooky umí na základě určité události provést konkrétní akci, tak se hodí, když chcete, aby platforma Click4Survey posílala oznámení do vaší aplikace hned, jakmile se v Click4Survey něco stane. Typickým příkladem webhooku je oznámení o vyplnění dotazníku respondentem.

Nastavení integrace API & Webhooky

Přístup k API

V této části stránky si můžete vygenerovat a zkopírovat API Token pro přístup k API v Click4Survey.

Dokumentaci k API naleznete na adrese https://api-docs.click4survey.com.

Webhooky

V této části stránky můžete nastavit adresy Vašich webhooků/stránek, které budou zpracovávat volání z Click4Survey. Více informací k jednotlivým webhookům najdete v naší dokumentaci.

Vlastní HTTP hlavičky

V okně pro přidání nebo úpravu webhooku můžete v části HTTP hlavičky přidat až 20 dvojic názvu a hodnoty. Například hlavička Authorization může obsahovat hodnotu Bearer vas-token. Hlavičky spravované Click4Survey, například Content-Type nebo X-C4S-Signature, nelze přepsat.

Ikonou Slučovací pole v hodnotě vložíte údaj dostupný pro vybranou událost. U přijetí odpovědi lze využít podporované odpovědi a uložené proměnné, při odhlášení kontaktní údaje a při spuštění nebo uzavření průzkumu údaje průzkumu. Značku můžete kombinovat s vlastním textem. Když změníte událost, dostupné značky se zkontrolují znovu.

Hodnoty musí být na jednom řádku, obsahovat pouze tisknutelné ASCII znaky a nemít mezery na začátku ani na konci. Pro chybějící hodnotu můžete použít výslovnou náhradní hodnotu, například {{$contact(external_id, default="unknown")}}. Chybná nebo nedostupná značka zabrání odeslání webhooku; v historii uvidíte důvod.

Hodnoty se vypočtou při vzniku události. Opakované odeslání použije stejné hodnoty. Historie jejich obsah nezobrazuje a u doručení s vlastními hlavičkami neukládá ani tělo odpovědi příjemce. Pokud část HTTP hlavičky není dostupná, jejich úpravy ještě nejsou zapnuté; již uložené nastavení zůstává zachováno.