API
Erilist privaatset lõpp-punkti pole. Mitte isegi liidese jaoks.
Enamikul toodetel on kaks API-t: dokumenteeritud, mida sulle pakutakse, ja huvitavam, mida nende enda ekraanid kasutavad. Teine on alati parem, ja sina ei tohi selle lähedale. Siin on üks, ja liides on selle klient nagu iga teine — mis on meile piirang ja põhjus, miks kõik, mida sa ehitada tahad, on võimalik.
Mida see reegel tegelikult maksab
See tähendab, et ekraan peab aeg-ajalt ootama, kuni API on õige, selle asemel et sellest mööda minna ühe mugava välja pärast. Päev, mil ekraan vajab midagi, mida avalik API anda ei saa, on päev, mil API on vale — ja parandus on API.
Tasu selle eest on, et kolm väga erinevat klienti ei maksa peaaegu midagi lisaks. MCP-server on klient. dash-b tiil on klient. Sinu enda skript on klient. Ükski neist pole teise klassi kodanik, kes mööda läheb kellelegi teisele disainitud liidesest, sest teist liidest, millele teiseks jääda, pole.
Dokumenteeritud ja läbiproovitud
OpenAPI luuakse aadressil /docs ja igal marsruudil on test, mis on dokumentatsioonis toodud näide. Dokumentatsioon, mis on koodist eraldi kirjutatud, hoiab kuu ajaga; dokumentatsioon, mis vale olles ehituse ära rikub, ei hoia.
Sisselogimine
Sinu castomo konto, authorization code flow koos PKCE-ga — sama konto, mida kasutad dash-b ja ülejäänud perekonna jaoks. Leht, millel oma serverit pole, teeb selle voolu täiesti hästi; just selle jaoks see disainiti. Masin-masinile tööks on projektipõhine API-võti.
- 1Inimesed
/v1/contacts·/lists·/segments·/tags·/imports - 2Sisu
/v1/creatives, koos valideerimise, eelvaate ja renderdamisega iga sihtgrupi jaoks - 3Automaatika
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Ülekanne
/v1/campaigns, kus sihtrühm, materialiseerimine, ajastamine ja saatmine on eraldi sammud - 5Sündmused sisse
/v1/events— sinu enda rakenduse sündmused, päästikuteks - 6Kohaletoimetamine
/sender-identities·/domains·/apps·/webhooks - 7Numbrid
/v1/reports/*ja/track/*jälgimishostil
OpenAPI aadressil /docs/mcp samal protsessil
Kokkulepped
Sama kuju nagu igal teisel castomo teenusel
Mis on olulisem, kui kõlada oskab. Kui sa juba kutsud üht neist, tead sa juba, kuidas see vastab, ebaõnnestub ja leheküljestab.
Üks veaümbris
Igal veal on sama kuju, stabiilne kood ja inimesele mõeldud sõnum. Ükski marsruut ei leiuta oma viisi rahulolematuseks.
Kursoripõhine leheküljestamine
Mitte niheid. Loend, mis muutub, kui sa seda läbi käid, ei jäta vaikselt ridu vahele ega korda neid — nihkepõhine leheküljestamine teeb seda vaikselt ja pidevalt.
Idempotsusvõtmed
Igal muutval marsruudil. Korda päringut, mille kohta sa pole kindel, et see kohale jõudis, ja saa sama vastus, mitte teine kontakt, teine kampaania või teine saatmine.
Piiratud projektiga
Token adresseerib ühte rentnikku ja ühte projekti, mõlemat. Reatasemeline turvalisus kehtestatakse andmebaasis endas, mitte selle peale mõtlemisega, et klausel lisada.
Veebihaavid välja
Allkirjastatud, uuesti proovitud koos tagasitõmbega ja kohaletoimetatud vähemalt korra — seega peaks ka sinu endpoint olema idempotentne. Sündmuste sõnavara on sama, mida aruanded kasutavad.
Kustutamine ja eksport
Kontakti saab API kaudu eksportida või kustutada, ja kustutamine jõuab igaühele õet teenusele, mis koopiat hoidis, läbi perekonna oma sisemise kanali.
Kõike, mida liides teha oskab, suudab POST teha.
Sündmused on huvitav osa
Kõik muu sellel lehel on torustik, mida sa ootad. POST /v1/events on tee, mis muudab seda, milleks toode on.
Sinu rakendus teab juba asju, mida ükski turundustööriist näha ei saa: kes lõpetas onboardingi, kes kutsus kolleegi, kes puuris vastu limiiti, kes eksportis oma andmed pühapäeva pärastlõunal. Postita need sündmustena oma tokeniga, ja igaüks neist saab päästikuks, tingimuseks ja segmendiks.
Ülejäänu tuleneb kontaktimudelist. Sündmusi liidetakse juurde, kunagi ei muudeta; nemad on logi, millele kogu toode toetub. Lehter, mis käivitub sinu defineeritud sündmusest, ei ole integratsioon — see on sama mehhanism, mida message_opened kasutab, teise nimega sees.
- 1Sa postitad selle
POST /v1/events— nimi, kontakt, payload, idempotentsusvõti. - 2See jõuab kohaleLisatakse kontakti logisse. Kellelgi pole vaja teada, et see eksisteerib.
- 3Lehter käivitubIga lehter, mille sisenemispunkt selle sündmuse nimetab, igale kontaktile, kes vastab selle sisenemistingimusele.
- 4Teised lehtrid harunevad selle järgi"Kas see sündmus on juhtunud viimase 14 päeva jooksul" on tavaline segmendi predikaat.
- iJa see lõpetab jooksusidEesmärgisõlm, mis nimetab sama sündmust, peatab jada sel hetkel, kui inimene asja teeb.
Sinu sõnavaraSinu token
Piirid, mida tasub enne ehitamist teada
ClickSomo hoiab sinu kohta kolme identifikaatorit — tenant, projekt ja kasutaja, läbipaistmatute id-dena — ja mitte midagi muud. Ei parooli, ei profiili, ei kaarti, ei arvet. Plaanide limiidid tulevad numbritena: mitu kontakti, mitu saatmist, mitu genereerimist. Maksete sõnavara ei ületa seda piiri üheski suunas.
Sinu kontaktid on sinu omad. Sina oled andmete vastutav töötleja; meie oleme volitatud töötleja. Ei ole teed, mille kaudu mõni teine perekonna toode saaks sinu kontaktloendit lugeda või kirjutada, ega ingestikanalit, mida kasutada.
Kui hindad seda tõsiselt: loe /docs enne, kui loed seda veebilehte veel edasi. API on aus kirjeldus sellest, mida toode teeb, ja iga väide nendel lehtedel vastab teele või sõlmetüübile, mida sealt leida saad. Kui skeem muutub, muutuvad need lehed.