ForestCRM API működése
Lépésről-lépésre
Ezt az oldalt technikai embereknek javasoljuk áttekinteni!
Egy weboldalról a ForestCRM-be legkönnyebben a ForestCRM ún. "Quickadd API" felületén lehet adatot bejuttatni. Ehhez olyan fejlesztőre van szükség, aki az adatbekérő oldalba Javascript kódot tud írni és elhelyezni.
A "Quickadd API" úgy működik, hogy kell kérni egy csak erre a célra használható API kulcsot a ForestCRM üzemeltetőktől (az [email protected] címen). Ennek a kulcsnak a birotkában meghívható a ForestCRM egy olyan szolgáltatása, amivel egyszerre, egy lépésben létre lehet hozni egy partnert, egy kapcsolattartót, egy üzleti lehetőséget és egy feladatot.
A Quickadd API részletes leírása itt található: https://app.forestcrm.hu/doc/api/quickadd.html
A Quickadd API használatának megkönnyítésére egy kis Javascript rutint is publikálunk, ami részletes dokumentációt tartalmaz a használatával kapcsolatban: https://app.forestcrm.hu/forestcrm_api.js
Összefoglalva, a rendszert legegyszerűbb a következő módon kiépíteni:
- Kell kérni egy Quickadd API kulcsot.
- Be kell illeszteni egy egyedi Javascript kódot az adatbekérő weboldalba, ami a form submit előtt, de a form validálása után fut le.
- Ebben össze kell állítani egy JSON adatstruktúrát az API dokumentációban vagy a https://app.forestcrm.hu/forestcrm_api.js fejléc kommentjében lévő struktúrának megfelelően. Egyes mezők (elsősorban az id-k) értékeit a ForestCRM-ből lehet megtudni (az adott elemre mutató linkekben található szám); de kérdés esetén szívesen segítünk. A többi mezőt (leírás, telefonszám, stb.) a form-ból kell venni, valamilyen fix értékre beállítani, vagy üresen hagyni.
- Az így összeállított JSON objektumot a ForestCRM Quickadd API-jára kell elküldeni POST-tal. (Ehhez az URL: https://app.forestcrm.hu/api/json/<QUICKADD API KEY>/quickadd) Értelemszerűen ennek AJAX hívásnak érdemes lennie, mert különben nem lehet az oldal tényleges form-ját annak rendes helyére beküldeni. Ebben segít a segéd rutin; annak betöltése után a forestCRM_API.quickadd(<quick_api_key>, <data>) hívással lehet az adatokat beküldeni.
- Amikor a fenti POST visszatér, akkor végre lehet hajtani az eredeti form submit-et, ezért azt a segéd rutin onSuccess callback-jébe érdemes tenni
A folyamat egyszerűen megvalósítható! További információért keress minket: [email protected]