API
Žiadny súkromný endpoint neexistuje. Ani pre rozhranie.
Väčšina produktov má dve API: zdokumentované, ktoré vám ponúknu, a to zaujímavé, ktoré používajú ich vlastné obrazovky. Druhé je vždy lepšie a nikdy sa k nemu nedostanete. Tu existuje len jedno a rozhranie je jeho klientom ako čokoľvek iné — čo je obmedzenie pre nás a dôvod, prečo je možné všetko, čo chcete postaviť.
Čo toto pravidlo skutočne stojí
Znamená to, že obrazovka si občas musí počkať, kým bude API správne, namiesto toho, aby ho obišla kvôli jednému vhodnému poľu. Deň, keď obrazovka potrebuje niečo, čo verejné API nedokáže dať, je deň, keď je API zlé, a riešením je API.
Výhodou je, že tri veľmi odlišní klienti nestoja takmer nič navyše. MCP server je klient. Dlaždice dash-b je klient. Váš vlastný skript je klient. Žiadny z nich nie je občan druhej kategórie obchádzajúci rozhranie navrhnuté pre niekoho iného, pretože žiadne iné rozhranie, ktorému by bolo treba ustúpiť, neexistuje.
Zdokumentované a preverené
OpenAPI sa generuje na /docs a každá trasa má test, ktorý je príkladom v dokumentácii. Dokumentácia písaná oddelene od kódu sa do mesiaca rozbehne; dokumentácia, ktorá pri chybe padne v builde, nie.
Prihlasovanie
Váš castomo účet cez authorization code flow s PKCE — ten istý účet, ktorý používate pre dash-b a zvyšok rodiny. Stránka bez vlastného servera zvládne tento flow úplne dobre; presne na to bol navrhnutý. Pre stroj-na-stroj prácu projektovo obmedzený API kľúč.
- 1Ľudia
/v1/contacts·/lists·/segments·/tags·/imports - 2Obsah
/v1/creativess validáciou, náhľadom a vykreslením pre každý cieľ - 3Automatizácia
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Vysielanie
/v1/campaignss publikom, materializáciou, plánovaním a odoslaním ako samostatnými krokmi - 5Prichádzajúce udalosti
/v1/events— udalosti vašej vlastnej aplikácie ako triggery - 6Doručenie
/sender-identities·/domains·/apps·/webhooks - 7Čísla
/v1/reports/*a/track/*na tracking hostiteľovi
OpenAPI na /docs/mcp na tom istom procese
Konvencie
Rovnaký tvar ako každá iná služba castomo
Čo je dôležitejšie, než to znie. Ak už voláte jednu z nich, už viete, ako táto odpovedá, zlyháva a stránkuje.
Jedna obálka chýb
Každé zlyhanie má rovnaký tvar, stabilný kód a správu určenú pre človeka. Žiadna trasa si nevymýšľa vlastný spôsob, ako byť nespokojná.
Stránkovanie kurzorom
Nie offsety. Zoznam, ktorý sa mení, kým ho prechádzate, potichu nepreskočí ani nezopakuje riadky — čo offset stránkovanie robí potichu a neustále.
Kľúče idempotencie
Na každej trase, ktorá mení dáta. Zopakujte požiadavku, pri ktorej si nie ste istí, či prebehla, a dostanete ten istý výsledok namiesto druhého kontaktu, druhej kampane alebo druhého odoslania.
Obmedzené na projekt
Token adresuje súčasne jeden tenant a jeden projekt. Zabezpečenie na úrovni riadkov vynucuje samotná databáza, nie pamätanie si pridať klauzulu.
Odchádzajúce webhooky
Podpísané, opakované s backoffom a doručené aspoň raz — takže aj váš endpoint má byť idempotentný. Udalosti používajú rovnakú slovnú zásobu ako prehľady.
Výmaz a export
Kontakt je možné exportovať alebo vymazať cez API a výmaz sa dostane ku každej sesterskej službe, ktorá má kópiu, cez vlastnú internú linku rodiny produktov.
Všetko, čo dokáže rozhranie, dokáže POST.
Udalosti sú to zaujímavé
Všetko ostatné na tejto stránke je inštalatérstvo, ktoré očakávate. POST /v1/events je trasa, ktorá mení, na čo produkt slúži.
Vaša aplikácia už vie veci, ktoré marketingový nástroj nemôže pozorovať: kto dokončil onboarding, kto pozval kolegu, kto narazil na limit, kto exportoval svoje dáta v nedeľu popoludní. Pošlite ich ako udalosti s vlastným tokenom a každá sa stane spúšťačom, podmienkou aj segmentom.
Zvyšok vyplýva z modelu kontaktu. Udalosti sa pripisujú, nikdy sa neupravujú; sú to záznamy, na ktorých visí celý produkt. Funnel spúšťaný udalosťou, ktorú ste definovali, nie je integrácia — je to ten istý mechanizmus, ktorý používa message_opened, len s iným názvom.
- 1Odošlete ju
POST /v1/events— názov, kontakt, payload a idempotency kľúč. - 2Doručí saPripíše sa do záznamu kontaktu. Nikto ďalší nemusí vedieť, že existuje.
- 3Spustí sa funnelKaždý funnel, ktorého vstup uvádza túto udalosť, pre každý kontakt spôsobilý podľa jeho vstupnej špecifikácie.
- 4Ostatné funnely sa podľa nej vetvia„Stala sa táto udalosť za posledných 14 dní“ je bežný predikát segmentu.
- iA ukončuje priebehyCieľový uzol uvádzajúci tú istú udalosť zastaví sekvenciu v momente, keď človek vykoná danú akciu.
Vaša slovná zásobaVáš token
Hranice, ktoré stojí za to poznať predtým, než začnete stavať
ClickSomo o vás uchováva tri identifikátory — tenant, projekt a používateľa, ako nepriehľadné id — a nič viac. Žiadne heslo, žiadny profil, žiadna karta, žiadna faktúra. Limity plánu prichádzajú ako čísla: koľko kontaktov, koľko odoslaní, koľko generovaní. Platobná terminológia neprechádza touto hranicou v žiadnom smere.
Vaše kontakty sú vaše. Vy ste správcom údajov; my sme spracovateľ. Neexistuje žiadna trasa, ktorou by iný produkt z rodiny mohol čítať alebo zapisovať váš zoznam kontaktov, ani ingest linka, ktorú by mohol použiť.
Ak to zvažujete vážne: prečítajte si /docs skôr, než budete čítať ďalšiu časť tejto stránky. API je úprimný popis toho, čo produkt robí, a každé tvrdenie na týchto stránkach sa mapuje na trasu alebo typ uzla, ktoré tam nájdete. Keď sa zmení schéma, menia sa aj tieto stránky.