REST API ja webhookit

Julkinen REST API, useita API-avaimia ja allekirjoitetut webhookit

Lisää asiakkaat verkkosivultasi, lomakkeeltasi tai taustajärjestelmästäsi yhdellä HTTP-kutsulla ja vastaanota jokainen muutos palvelimellesi HMAC-SHA256:lla allekirjoitettuna.

CRM ei ole enää paikka, johon pitää mennä kirjoittamaan: siitä tulee päätepiste, jota järjestelmäsi kutsuvat.

AiCrm, AIsToHiren CRM-sovellus, tarjoaa julkisen REST API:n omiin kontakteihisi. Avaimella `X-Api-Key`-otsikossa voit luoda, listata, hakea, päivittää ja poistaa kontakteja sekä lisätä toimintoja mihin tahansa niistä verkkosivusi lomakkeelta, chattibotistasi, Zapista, Python-skriptistä tai omasta taustajärjestelmästäsi. Vastaukset ovat JSON-muotoisia muodossa `{ success, data }`, ja raja on 100 pyyntöä minuutissa avainta kohden.

API:n kautta tehty lisäys ei kahdenna: jos lähettämäsi sähköposti on jo rekisterissäsi, AiCrm päivittää jo olemassa olevan kortin (täydentää puuttuvan puhelinnumeron, nimen tai yrityksen, yhdistää tunnisteet) ja kirjaa aikajanalle uuden lähetyksen palauttaen HTTP 200:n. Jos kontakti on uusi, se luodaan ja palautetaan 201. Jokainen API:n kautta tullut kontakti saa automaattisesti tunnisteen `api-lead`, säilyttää lähettämäsi tunnisteet ja tallentaa alkuperäisen `subId`:n sekä maan, IP-osoitteen ja selaimen, joilla se saapui.

Voit luoda jopa 20 omalla nimellä varustettua API-avainta sovelluksen sisäisen avaimen lisäksi. Näin annat eri avaimen jokaiselle integraatiolle – verkkosivulle, toukokuun kampanjan lomakkeelle, harjoittelijalle, toimittajalle – ja peruutat sen erikseen, kun integraatio päättyy, muita koskematta. Avaimen koko arvo näytetään vain kerran, luontihetkellä, ja sen jälkeen se näkyy listassa vain peitettynä.

Toiseen suuntaan webhookit ilmoittavat järjestelmillesi. Määrität jopa 10 kohdetta, valitset, mihin tapahtumiin kukin tilaa (`customer.created`, `customer.updated`, `customer.deleted`, `activity.created`), ja AiCrm tekee POST-pyynnön URL-osoitteeseesi otsikoilla `X-AiCrm-Event` ja `X-AiCrm-Signature: sha256=…`, joka on sisällön HMAC-SHA256-allekirjoitus kyseisen webhookin salaisuudella, jotta voit varmistaa toimituksen aitouden. URL-osoitetta tallennettaessa SSRF-suojaus hylkää localhostin, 127.0.0.0/8:n, 10.x:n, 192.168.x:n, 172.16-31.x:n, ::1:n, 0.0.0.0:n sekä `.local`- ja `.internal`-verkkotunnukset.

Edut: REST API ja webhookit

Kontaktin luonti yhdellä kutsulla

yksi POST-pyyntö osoitteeseen `/api/apps/public/crm/customers` sähköpostilla ja haluamillasi tunnisteilla, ja liidi on jo luokiteltuna CRM:ssäsi.

Ei kaksoiskappaleita jo rakenteen puolesta

jos sähköposti on jo olemassa, kortti päivitetään ja uusi lähetys kirjataan sen aikajanalle toisen kortin luomisen sijaan.

Jopa 20 nimettyä avainta

yksi kutakin integraatiota kohden, ja jokainen peruutettavissa erikseen. Jos yksi avain vuotaa, poistat sen, eikä mikään muu lakkaa toimimasta.

Webhookit allekirjoitetaan HMAC-SHA256

lla: tarkistat `X-AiCrm-Signature`-otsikon salaisuudellasi ja tiedät, että ilmoitus tulee omasta CRM:ästäsi eikä ulkopuoliselta.

SSRF-suojaus mukana

sovellus kieltäytyy toimittamasta webhookeja localhostiin tai yksityisiin verkkoalueisiin, joten CRM:äsi ei voi käyttää sisäisen verkon luotaamiseen.

Täysi CRUD, ei pelkkiä lisäyksiä

listaus sivutuksella ja suodattimilla (haku, tila, tunnisteet, maa), kontaktin haku toimintoineen, päivitys, poisto ja toimintojen kirjaus.

Alkuperä jäljitetään automaattisesti

jokainen API:n kautta tehty lisäys tallentaa lähettämäsi `subId`:n sekä maan, IP-osoitteen ja selaimen, ja se merkitään tunnisteella `api-lead`, jotta voit suodattaa sen myöhemmin sovelluksessa.

Testaus ilman arvailua

sovelluksessa on päätepisteiden dokumentaatio kopioitavan `curl`-esimerkin kera sekä painike, jolla lähetät testitoimituksen kullekin webhookille, ja näet viimeisen yrityksen tilan ja ajan.

Claire Donovan

Yhdistä verkkosivusi CRM:ääsi jo tänä iltana

AiCrm on AIsToHiren CRM-työkalu, joka vastaanottaa kontaktisi REST API:n kautta ja ilmoittaa järjestelmillesi allekirjoitetuilla webhookeilla. Luo tili, luo avain ja tee ensimmäinen kutsu.

CRM:n REST API ja allekirjoitetut webhookit | AiCrm