API
Neexistuje žádný soukromý endpoint. Ani pro rozhraní.
Většina produktů má dvě API: to zdokumentované, které vám nabídnou, a to zajímavé, které používají jejich vlastní obrazovky. To druhé je vždy lepší a nikdy se k němu nedostanete. Tady je jen jedno a rozhraní je jeho klientem jako cokoli jiného — což je pro nás omezení a důvod, proč je všechno, co chcete postavit, možné.
Co to pravidlo doopravdy stojí
Znamená to, že si obrazovka musí občas počkat, až API bude mít pravdu, místo aby se kolem něj dostala k jednomu vhodnému poli. Den, kdy obrazovka potřebuje něco, co veřejné API nedá, je den, kdy je API špatné — a opravou je API.
Odměnou je, že tři velmi odlišní klienti nestojí téměř nic navíc. MCP server je klient. Dlaždice v dash-b je klient. Váš vlastní skript je klient. Žádný z nich není občan druhé kategorie, který obchází plochu navrženou pro někoho jiného, protože žádná jiná plocha neexistuje.
Zdokumentované a prověřené
OpenAPI se generuje na /docs a každá trasa má test, který je zároveň příkladem v dokumentaci. Dokumentace psaná odděleně od kódu se do měsíce rozjede; dokumentace, která při chybě shodí build, ne.
Přihlašování
Váš účet castomo přes authorization code flow s PKCE — tentýž účet, který používáte pro dash-b a zbytek rodiny. Stránka bez vlastního serveru zvládne tento tok bez problémů; přesně pro to byl navržen. Pro komunikaci stroj–stroj klíč API vázaný na projekt.
- 1Lidé
/v1/contacts·/lists·/segments·/tags·/imports - 2Obsah
/v1/creativess validací, náhledem a vykreslením pro každý cíl - 3Automatizace
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Vysílání
/v1/campaignss publikem, materializací, plánováním a odesláním jako samostatnými kroky - 5Příchozí události
/v1/events— události z vaší vlastní aplikace jako triggery - 6Doručování
/sender-identities·/domains·/apps·/webhooks - 7Čísla
/v1/reports/*a/track/*na trackovacím hostu
OpenAPI na /docs/mcp na stejném procesu
Konvence
Stejný tvar jako u každé jiné služby castomo
Což záleží víc, než to zní. Pokud už jedno z těchto API voláte, už víte, jak tohle odpovídá, jak selhává a jak stránkuje.
Jedna obálka chyb
Každé selhání má stejný tvar, stabilní kód a zprávu určenou pro člověka. Žádná trasa si nevymýšlí vlastní způsob, jak být nespokojená.
Stránkování kurzorem
Ne offsety. Seznam, který se mění, zatímco jím procházíte, tiše nepřeskakuje ani neopakuje řádky — což offsetové stránkování dělá potichu a neustále.
Klíče idempotence
Na každé měnící trase. Zopakujte požadavek, u kterého si nejste jistí, že došel, a dostanete stejnou odpověď místo druhého kontaktu, druhé kampaně nebo druhého rozeslání.
Vymezeno na projekt
Token adresuje najednou jednoho tenanta i jeden projekt. Zabezpečení na úrovni řádků vynucuje sama databáze, ne to, že si někdo pamatuje přidat klauzuli.
Odchozí webhooky
Podepsané, opakované s exponenciálním čekáním a doručované nejméně jednou — takže i váš koncový bod by měl být idempotentní. Události používají stejnou slovní zásobu jako reporty.
Výmaz a export
Kontakt lze exportovat nebo vymazat přes API a výmaz se přes interní kanál rodiny dostane ke každé sesterské službě, která kopii držela.
Vše, co umí rozhraní, umí i POST.
Události jsou ta zajímavá část
Všechno ostatní na této stránce je instalatérství, které čekáte. POST /v1/events je trasa, která mění to, k čemu produkt slouží.
Vaše aplikace už ví věci, které žádný marketingový nástroj nevidí: kdo dokončil onboarding, kdo pozval kolegu, kdo narazil na limit, kdo si v neděli odpoledne vyexportoval svá data. Pošlete je jako události se svým tokenem a každá z nich se stane triggerem, podmínkou i segmentem.
Zbytek plyne z modelu kontaktu. Události se pouze přidávají, nikdy se neupravují; jsou to protokoly, na kterých visí celý produkt. Funnel spuštěný událostí, kterou jste definovali, není integrace — je to stejný mechanismus, jaký používá message_opened, jen s jiným názvem uvnitř.
- 1Vy ji odešlete
POST /v1/events— název, kontakt, payload a idempotenční klíč. - 2Doručí sePřidá se do protokolu kontaktu. Nikdo další nemusí vědět, že existuje.
- 3Spustí se funnelKaždý funnel, jehož vstup tento název události uvádí, pro každý kontakt splňující podmínky vstupu.
- 4Ostatní funnely se podle ní větví„Stala se tato událost za posledních 14 dní“ je běžný predikát segmentu.
- aA ukončuje běhyCílový uzel pojmenovávající tutéž událost zastaví sekvenci v okamžiku, kdy člověk danou věc udělá.
Vaše slovní zásobaVáš token
Hranice, které stojí za to znát, než začnete stavět
ClickSomo o vás ukládá tři identifikátory — tenanta, projekt a uživatele, jako neprůhledná id — a nic víc. Žádné heslo, žádný profil, žádnou kartu, žádnou fakturu. Limity tarifu přicházejí jako čísla: kolik kontaktů, kolik rozesílek, kolik generování. Platební slovní zásoba touto hranicí neprochází ani jedním směrem.
Vaše kontakty jsou vaše. Vy jste správcem dat; my jsme zpracovatel. Neexistuje žádná trasa, kterou by jiný produkt rodiny mohl číst nebo zapisovat váš seznam kontaktů, ani žádný ingestní kanál, který by k tomu mohl použít.
Pokud toto hodnotíte vážně: přečtěte si /docs, dříve než cokoli dalšího na tomto webu. API je upřímný popis toho, co produkt dělá, a každé tvrzení na těchto stránkách odpovídá trase nebo typu uzlu, které tam najdete. Když se změní schéma, mění se i tyto stránky.