REST-API en webhooks

Openbare REST-API met meerdere API-sleutels en ondertekende webhooks

Maak klanten aan vanaf je website, je formulier of je backend met één HTTP-aanroep en ontvang elke wijziging op je server, ondertekend met HMAC-SHA256.

Je CRM is niet langer een plek waar je naartoe moet om te typen: het wordt een endpoint dat je systemen aanroepen.

AiCrm, de CRM-app van AIsToHire, stelt een openbare REST-API beschikbaar over je eigen contacten. Met een sleutel in de header `X-Api-Key` kun je contacten aanmaken, opsommen, opvragen, bijwerken en verwijderen en activiteiten aan elk van hen toevoegen, vanuit het formulier van je website, je chatbot, een Zap, een Python-script of je eigen backend. De antwoorden zijn JSON met de vorm `{ success, data }`, en de limiet is 100 verzoeken per minuut en sleutel.

Aanmaken via de API dupliceert niet: bestaat het e-mailadres dat je meestuurt al in je database, dan werkt AiCrm de kaart bij die je al had (vult het ontbrekende telefoonnummer, de naam of het bedrijf aan, voegt de labels samen) en registreert een nieuwe verzending in haar timeline, met HTTP 200 als antwoord; is het nieuw, dan maakt het het aan en geeft 201 terug. Elk contact dat via de API binnenkomt, wordt automatisch gelabeld als `api-lead`, behoudt de labels die jij meestuurt en bewaart de `subId` van herkomst, plus het land, het IP-adres en de browser waarvandaan het kwam.

Je kunt tot 20 API-sleutels met een eigen naam hebben, naast de interne sleutel van de app. Zo geef je elke integratie (de website, het formulier van de meicampagne, de stagiair, de leverancier) een andere sleutel en trek je die alleen in wanneer die integratie eindigt, zonder de andere aan te raken. De volledige waarde van een sleutel wordt maar één keer getoond, bij het aanmaken; daarna zie je ze alleen gemaskeerd in de lijst.

In de andere richting waarschuwen de webhooks je systemen. Je stelt tot 10 bestemmingen in, kiest op welke gebeurtenissen elk zich abonneert (`customer.created`, `customer.updated`, `customer.deleted`, `activity.created`) en AiCrm doet een POST naar je URL met de headers `X-AiCrm-Event` en `X-AiCrm-Signature: sha256=…`, de HMAC-SHA256-handtekening van de body met het geheim van die webhook, zodat je kunt controleren of de levering legitiem is. Bij het opslaan van de URL weigert een anti-SSRF-beveiliging localhost, 127.0.0.0/8, 10.x, 192.168.x, 172.16-31.x, ::1, 0.0.0.0 en de domeinen `.local` en `.internal`.

Voordelen van REST-API en webhooks

Contacten aanmaken met één aanroep

een POST naar `/api/apps/public/crm/customers` met het e-mailadres en de labels die je wilt, en de lead staat al geclassificeerd in je CRM.

Geen duplicaten door ontwerp

bestaat het e-mailadres al, dan wordt de kaart bijgewerkt en wordt de nieuwe verzending in haar timeline genoteerd in plaats van een tweede kaart aan te maken.

Tot 20 benoemde sleutels

één per integratie, afzonderlijk in te trekken. Lekt een sleutel uit, dan verwijder je alleen die en stopt er verder niets met werken.

Webhooks ondertekend met HMAC-SHA256

je controleert de header `X-AiCrm-Signature` met je geheim en weet dat de melding van je CRM komt en niet van een derde.

Anti-SSRF-beveiliging inbegrepen

de app weigert webhooks af te leveren op localhost of op privénetwerkbereiken, zodat je CRM niet kan worden gebruikt om een intern netwerk af te tasten.

Volledige CRUD, niet alleen aanmaken

lijsten met paginering en filters (zoeken, status, labels, land), een contact opvragen met zijn activiteit, bijwerken, verwijderen en er activiteiten aan registreren.

Herkomst automatisch vastgelegd

elke aanmaak via de API bewaart de `subId` die je meestuurt plus het land, het IP-adres en de browser, en wordt gelabeld als `api-lead` om er later in de app op te filteren.

Testen zonder te gokken

de app bevat de documentatie van de endpoints met een kopieerbaar `curl`-voorbeeld en een knop om een testlevering naar elke webhook te sturen, met de status en het tijdstip van de laatste poging.

Claire Donovan

Koppel je website vanmiddag nog aan je CRM

AiCrm is de CRM-tool van AIsToHire die je contacten via REST-API ontvangt en je systemen verwittigt met ondertekende webhooks. Maak je account aan, genereer een sleutel en doe de eerste aanroep.

REST-API voor CRM met ondertekende webhooks | AiCrm