JavaScript API

Pro zjednodušení integrace vašeho webu s CRM má aplikace k dispozici jednoduchý skript, který můžete vložit do své stránky pomocí kódu. Tento skript má závislost na jQuery.

<script src="https://.../jquery-3.4.1.min.js" type="text/javascript"></script> <!-- závislost -->
<script src="https://firma.itcrm.cz/api.js" type="text/javascript"></script>

kde https://firma.itcrm.cz nahraďte adresou své vlastní instalace InTouch CRM.

Uvedený skript vytvoří globální proměnnou CRM s těmito vlastnostmi a metodami:

Vlastnosti

{string} version

Obsahuje verzi CRM (např. 6.1.0.8)

Metody

isKnownEmail(email, callback)

Metoda testuje, jestli e-mailová adresa v parametru email jež existuje v databázi CRM.

{string} email

E-mailová adresa

{function} callback

Funkce, která bude asynchronně zavolána, jakmile vrátí server výsledek. Funkce dostane jeden parametr s objektem popsaným níže.

Výsledek od serveru

{
	"exists" : true, /* Příznak, jestli už kontaktní údaj existuje v databázi CRM */
	"party" : 35, /* Kód kontaktu, u kterého byl kontaktní údaj nalezen */
	"name" : "Karel Novák", /* Název kontaktu, u kterého byl kontaktní údaj nalezen */
	"type" : "INDIVIDUAL", /* Typ identity kontaktu, u kterého byl kontaktní údaj nalezen */
	"frontPath" : "https://...", /* URL stránky, kde může kontakt editovat svoje GDPR souhlasy */
	"frontKey" : "6c1b53e51a2e467a6a3b53f1"	/* Klíč, pomocí, kterého můžete provádět další operace (např. sendForgotPassword) */
}

Typy identit kontaktů jsou definovány zde.

V případě, že při zpracování požadavku došlo k chybě, je vrácen objekt ve tvaru:

{
	"error" : "popis chyby"
}

isKnownPhone(phone, callback)

Metoda testuje, jestli telefonní číslo v parametru phone jež existuje v databázi CRM.

{string} phone

Telefonní číslo

{function} callback

Funkce, která bude asynchronně zavolána, jakmile vrátí server výsledek. Funkce dostane jeden parametr s objektem popsaným níže.

Formát vráceného výsledku do callback funkce je stejný, jako u metody isKnownEmail()

sendForgotPassword(emailOrLogin, serviceName, reset, callback)

Metoda zajistí, že CRM odešle zákazníkovi zapomenuté heslo e-mailem.

{string} emailOrLogin

E-mailová adresa nebo přihlašovací jméno zákazníka, kterému má být zasláno zapomenuté heslo.

{string} serviceName

Název vaší služby (webu), kde zákazník o zaslání požádal

{boolean} reset

Příznak, jestli se má heslo resetovat a nebo jestli má být pouze zasláno existující.

{function} callback

Asynchroně volaná funkce s výsledkem od serveru (objekt předaný parametrem)