API
Ni zasebnih končnih točk. Niti za vmesnik.
Večina izdelkov ima dva API-ja: dokumentiranega, ki vam ga ponudijo, in zanimivega, ki ga uporabljajo njihovi lastni zasloni. Drugi je vedno boljši in do njega nikoli nimate dostopa. Tu je samo en, vmesnik pa je njegov odjemalec kot vse ostalo — to je omejitev za nas in razlog, da je vse, kar želite zgraditi, mogoče.
Kaj ta pravilo dejansko stane
Pomeni, da se mora zaslon včasih počakati, da API postane pravilen, namesto da se mu izogne za eno priročno polje. Dan, ko zaslon potrebuje nekaj, česar javni API ne more dati, je dan, ko je API narobe, in rešitev je API.
Korist je, da trije zelo različni odjemalci ne stanejo skoraj nič dodatnega. Strežnik MCP je odjemalec. Tile v dash-b je odjemalec. Vaša lastna skripta je odjemalec. Noben od njih ni državljan drugega razreda, ki se izogiba vmesniku, zasnovanem za nekoga drugega, ker drugega vmesnika ni.
Dokumentiran in preizkušen
OpenAPI se ustvari na /docs in vsaka pot ima test, ki je primer v dokumentaciji. Dokumentacija, napisana ločeno od kode, se v mesecu dni razide; dokumentacija, ki pri napaki ustavi gradnjo, pa ne.
Prijava
Vaš račun castomo prek avtorizacijskega toka z PKCE — isti račun, ki ga uporabljate za dash-b in ostalo družino. Stran brez lastnega strežnika ta tok izvede brez težav; zato je bil zasnovan. Za delo med stroji je API-ključ, vezan na projekt.
- 1Ljudje
/v1/contacts·/lists·/segments·/tags·/imports - 2Vsebina
/v1/creativesz validacijo, predogledom in izrisom na cilj - 3Avtomatizacija
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Oddajanje
/v1/campaignsz občinstvom, materializacijo, razporejanjem in pošiljanjem kot ločenimi koraki - 5Dogodki noter
/v1/events— dogodki vaše lastne aplikacije kot sprožilci - 6Dostava
/sender-identities·/domains·/apps·/webhooks - 7Številke
/v1/reports/*in/track/*na gostitelju za sledenje
OpenAPI na /docs/mcp na istem procesu
Konvencije
Ista oblika kot pri vsaki drugi storitvi castomo
Kar je pomembnejše, kot se zdi. Če že klicete eno od teh, že veste, kako ta odgovarja, odpove in razvršča po straneh.
Ena ovojnica za napake
Vsaka napaka ima isto obliko, stabilno kodo in sporočilo, namenjeno človeku. Nobena pot ne izumlja lastnega načina nezadovoljstva.
Straniščenje s kazalci
Ne z odmiki. Seznam, ki se med pregledovanjem spreminja, ne preskoči ali ponovi vrstic v tičini, kar straniščenje z odmiki počne tiho in nenehno.
Ključi idempotentnosti
Na vsaki poti, ki spreminja podatke. Ponovite zahtevo, za katero niste prepričani, da je prišel, in dobite isti odgovor namesto drugega stika, druge kampanje ali druge pošiljke.
Omejeno na projekt
Žeton naslavlja enega najemnika in en projekt, oboje. Varnost na ravni vrstic se uveljavlja v sami podatkovni zbirki, ne s tem, da si zapomnite dodati pogoj.
Odhodni spletni kljuke (webhooks)
Podpisane, ponovljene z odmikom in dostavljene vsaj enkrat — zato mora biti Vaš končni točki (endpoint) prav tako idempotenten. Dogodki uporabljajo isti besednjak kot poročila.
Izbris in izvoz
Kontakt lahko izvozite ali izbrišete prek API-ja, izbris pa doseže vsako sestrsko storitev, ki ima kopijo, prek družinskega notranjega kanala.
Vse, kar zmaga vmesnik, zmaga tudi POST.
Dogodki so zanimivi del
Vse ostalo na tej strani je instalacija, ki jo pričakujete. POST /v1/events je pot, ki spreminja namen izdelka.
Vaša aplikacija že ve stvari, ki jih nobeno marketinško orodje ne more opazovati: kdo je zaključil uvedbo, kdo je povabil sodelavca, kdo je zadel omejitev, kdo je izvozil svoje podatke v nedeljsko popoldne. Objavite jih kot dogodke s svojim žetonom in vsak postane sprožilec, pogoj in segment.
Ostalo sledi iz modela stika. Dogodki se dodajajo, nikoli ne urejajo; to je dnevnik, na katerem visi celoten izdelek. Lijevka, ki se sproži na dogodek, ki ste ga definirali Vi, ni integracija — to je isti mehanizem, ki ga uporablja message_opened, le z drugim imenom.
- 1Vi ga objavite
POST /v1/events— ime, stik, vsebina (payload), ključ idempotentnosti. - 2DospedeDoda se v dnevnik stika. Nihče drug ne potrebuje vedeti, da obstaja.
- 3Lijevka se zaženeVsaka lijevka, katere vstop omenja ta dogodek, za vsak stik, ki izpolnjuje pogoje njenega vstopnega pravila.
- 4Druge lijevke se na njem razvejijo„Ali se je ta dogodek zgodil v zadnjih 14 dneh“ je običajen predikat segmenta.
- iIn konča izvajanjaCiljno vozlišče, ki omenja isti dogodek, ustavi zaporedje v trenutku, ko oseba stori dejanje.
Vaš besednjakVaš žeton
Meje, ki jih je vredno poznati, preden začnete graditi
ClickSomo hrani o Vas tri identifikatorje — najemnika (tenant), projekt in uporabnika, kot neprozorne id-je — in nič drugega. Brez gesla, brez profila, brez kartice, brez računa. Omejitve paketa prispejo kot številke: koliko stikov, koliko pošiljanj, koliko generiranj. Plačilni besednjak ne prečka te meje v nobeno smer.
Vaši stiki so Vaši. Vi ste upravljavec podatkov; mi smo obdelovalec. Ne obstaja pot, po kateri bi drug izdelek v družini lahko bral ali pisal Vaš seznam stikov, in ni kanala za vnos, ki bi ga lahko uporabil.
Če to resno presojate: preberite /docs, preden preberete še kaj več s tega spletnega mesta. API je iskren opis tega, kaj izdelek počne, in vsaka trditev na teh straneh se preslika v pot ali vrsto vozlišča, ki ju tam najdete. Ko se shema spremeni, se spremenijo te strani.