D'API
Et gëtt keen privaten Endpoint. Net emol fir d'Interface.
Déi meescht Produkter hunn zwou APIen: déi dokumentéiert, déi ugebuede gëtt, an déi interessant, déi hir eegen Ecranen benotzen. Déi zweet ass ëmmer besser, an Dir kënnt ni drun. Hei gëtt et just eng, an d'Interface ass e Client vun hir wéi alles anescht — dat ass eng Contrainte fir eis, an de Grond, firwat alles, wat Dir bauen wëllt, méiglech ass.
Wat d'Reegel wierklech kascht
Et heescht, datt en Ecran heiansdo muss waarden, bis d'API richteg ass, amplaz ronderëm se ze gräife fir een praktescht Feld. Den Dag, wou en Ecran eppes braucht, wat déi ëffentlech API net gëtt, ass den Dag, wou d'API falsch ass — an d'Léisung ass d'API.
De Profit ass, datt dräi ganz ënnerschiddlech Clienten bal näischt extra kaschten. Den MCP-Server ass e Client. Eng dash-b Kachel ass e Client. Ären eegene Skript ass e Client. Kee vun hinnen ass e Client zweete Klass, deen ronderëm eng Uewerfläch schafft, déi fir een aneren entworf gouf, well et keng aner Uewerfläch gëtt.
Dokumentéiert, an getest
OpenAPI gëtt op /docs generéiert, an all Route huet en Test, deen d'Beispill an der Dokumentatioun ass. Dokumentatioun, déi separat vum Code geschriwwe gëtt, drifft bannen engem Mount of; Dokumentatioun, déi de Build falen léisst, wann se falsch ass, net.
Aloggen
Äre castomo-Kont, iwwer den Authorization-Code-Flow mat PKCE — deen selwechte Kont, deen Dir fir dash-b an de Rescht vun der Famill benotzt. Eng Säit ouni eegenen Server féiert dëse Flow perfekt aus; et ass genau dat, woufir e entworf gouf. Fir Maschin-zu-Maschin-Aarbecht: en API-Schlëssel op Projet-Ebene.
- 1Leit
/v1/contacts·/lists·/segments·/tags·/imports - 2Inhalt
/v1/creatives, mat Validatioun, Preview a Render pro Zil - 3Automatiséierung
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Emissioun
/v1/campaigns, mat Audience, Materialiséieren, Planung a Verschécken als getrennte Schrëtt - 5Evenementer eran
/v1/events— d'Evenementer vun Ärer eegener Applikatioun, als Ausléser - 6Zoustellung
/sender-identities·/domains·/apps·/webhooks - 7Zuelen
/v1/reports/*, an/track/*um Tracking-Host
OpenAPI op /docs/mcp um selwechte Prozess
Konventiounen
Déi selwecht Form wéi all anere castomo-Service
Dat ass méi wichteg wéi et kléngt. Wann Dir schonn eng vun dësen urufft, wësst Dir schonn, wéi dës eng äntwert, scheitert a paginéiert.
Een Error-Envelope
All Feeler huet déi selwecht Form, e stabilen Code an eng Message fir e Mënsch. Keng Route erfindt hir eegen Aart, onglécklech ze sinn.
Cursor-Paginatioun
Keng Offsets. Eng Lëscht, déi sech ännert, während Dir se duerchgeet, iwwerspréngt oder widderhëlt keng Zeilen heemlech — wat Offset-Paginatioun roueg a bestänneg mécht.
Idempotenz-Schlësselen
Op all rutt déi eppes ännert. Widderhuel eng Ufro bei där Dir net sécher sidd ob se ukomm ass, an Dir kritt déi selwecht Äntwerten amplaz vun engem zweete Kontakt, enger zweeter Kampagne oder enger zweeter Sendung.
Op e Projet limitéiert
E Token adresséiert e Mandant an e Projet, béid. Row-Level Security gëtt an der Datebank selwer duerchgesat, net doduerch datt een drun denkt eng Klausel derbäi ze setzen.
Webhooks eraus
Signéiert, mat Backoff widderholl, a mindestens eemol geliwwert — also sollt Ären Endpoint och idempotent sinn. D'Evenementer benotzen de selwechte Vokabular wéi d'Berichter.
Läschen an Export
E Kontakt kann iwwer d'API exportéiert oder geläscht ginn, an eng Läschung erreecht all Géigeservice deen eng Kopie huet, iwwer den eegene internale Kanal vun der Famill.
Alles wat d'Interface ka maachen, kann e POST maachen.
D'Evenementer sinn den interessante Deel
Alles anescht op dëser Säit ass Installatioun déi Dir erwaart. POST /v1/events ass d'Rutt déi ännert firwat d'Produkt do ass.
Är Applikatioun weess schonn Dingen déi kee Marketing-Tool ka gesinn: wien d'Onboarding fäerdeg huet, wien e Kolleege agelueden huet, wien op eng Limit stéisst, wien e Sonndeg nomëtteg seng Daten exportéiert. Schéckt déi als Evenementer mat Ärem eegene Token, a jiddwereen dovunner gëtt en Trigger, eng Konditioun an e Segment.
De Rescht kënnt aus dem Kontaktmodell. Evenementer ginn ugehaang, ni geännert; si sinn de Log op deem dat ganzt Produkt hänkt. E Funnel deen op en Evenement ausléist dat Dir definéiert hutt ass keng Integratioun — et ass de selwechte Mechanismus wéi message_opened, mat engem aneren Numm dran.
- 1Dir schéckt en
POST /v1/events— en Numm, e Kontakt, e Payload, en Idempotenz-Schlëssel. - 2E kënnt unUgehaang un de Log vum Kontakt. Näischt anescht muss wëssen datt et existéiert.
- 3E Funnel fänkt unAll Funnel deem säin Entrée dësen Evenement nennt, fir all Kontakt deen ënner senger Entrée-Spezifikatioun qualifizéiert ass.
- 4Aner Funnelen verzweigen drop"Ass dësen Evenement an de leschten 14 Deeg geschitt" ass e gewéinleche Segment-Prädikat.
- iAn en stoppt LäifenE Goal-Node deen de selwechten Evenement nennt stoppt eng Sequenz am Moment wou d'Persoun d'Saach mécht.
Äre VokabularÄren Token
Grenzen déi et wäert ze wësse bevir Dir baut
ClickSomo späichert dräi Identifikatiounen iwwer Iech — e Mandant, e Projet an e Benotzer, als opak Ids — an näischt anescht. Kee Passwuert, kee Profil, keng Kaart, keng Rechnung. Plan-Limite kommen als Zuelen: wivill Kontakter, wivill Sendungen, wivill Generatiounen. Bezuel-Vokabular geet d'Linn an keng Richtung iwwer.
Är Kontakter sinn Är. Dir sidd de Data Controller; mir sinn de Processor. Et gëtt kee Wee iwwer deen en anert Produkt aus der Famill Är Kontaktlëscht liese oder schreiwen kann, an et gëtt keen Ingest-Kanal fir een dozou ze benotzen.
Wann Dir dat seriös evaluéiert: liest /docs bevir Dir méi vun dëser Websäit liest. D'API ass déi éierlech Beschreiwung vun dem wat d'Produkt mécht, an all Behauptung op dëse Säiten entsprécht enger Rutt oder engem Node-Typ deen Dir do fannt. Wann de Schema sech ännert, änneren dës Säite sech.