API
Yksityistä päätepistettä ei ole. Ei edes käyttöliittymälle.
Useimmilla tuotteilla on kaksi API:a: dokumentoitu, jota sinulle tarjotaan, ja kiinnostavampi, jota niiden omat näytöt käyttävät. Toinen on aina parempi, eikä sinua koskaan päästetä sen lähelle. Tässä on yksi, ja käyttöliittymä on sen asiakas kuin mikä tahansa muu — mikä on rajoite meille ja syy sille, että kaikki mitä haluat rakentaa, on mahdollista.
Mitä tämä sääntö oikeasti maksaa
Se tarkoittaa, että näytön on joskus odotettava, että API saadaan kuntoon, sen sijaan että se kiertäisi sen yhden kätevän kentän takia. Päivä, jona näyttö tarvitsee jotain, mitä julkinen API ei voi antaa, on päivä, jona API on väärässä — ja korjaus on API.
Hyötynä on, että kolme hyvin erilaista asiakasta ei maksa käytännössä mitään lisää. MCP-palvelin on asiakas. Dash-b:n tiili on asiakas. Oma skriptisi on asiakas. Mikään niistä ei ole toisen luokan kansalainen, joka kiertää jonkun muun varten suunniteltua rajapintaa, koska muuta rajapintaa ei ole olemassa.
Dokumentoitu ja harjoitettu
OpenAPI generoidaan osoitteeseen /docs, ja jokaisella reitillä on testi, joka on dokumentaation esimerkki. Koodista erikseen kirjoitettu dokumentaatio ajautuu kuukaudessa; dokumentaatio, joka epäonnistuttaa buildin ollessaan väärässä, ei.
Sisäänkirjautuminen
Castomo-tilisi, authorization code -flow PKCE:llä — sama tili, jota käytät dash-b:ssä ja muualla perheessä. Sivu, jolla ei ole omaa palvelinta, suorittaa tuon flow'n täysin hyvin; se on juuri se, mihin flow suunniteltiin. Koneelta koneelle -työhön projektiin rajattu API-avain.
- 1Ihmiset
/v1/contacts·/lists·/segments·/tags·/imports - 2Sisältö
/v1/creatives, validoinnilla, esikatselulla ja renderöinnillä kohdetta kohden - 3Automaatio
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Lähetys
/v1/campaigns, jossa kohderyhmä, materialisointi, aikataulutus ja lähetys ovat erillisiä vaiheita - 5Tapahtumat sisään
/v1/events— oman sovelluksesi tapahtumat triggereinä - 6Toimitus
/sender-identities·/domains·/apps·/webhooks - 7Numerot
/v1/reports/*sekä/track/*seurantahostilla
OpenAPI osoitteessa /docs/mcp samassa prosessissa
Käytännöt
Sama muoto kuin kaikissa muissa castomo-palveluissa
Mikä on tärkeämpää kuin kuulostaa. Jos kutsut jo yhtä näistä, tiedät jo, miten tämä vastaa, epäonnistuu ja sivuttaa.
Yksi virhekääre
Jokaisella virheellä on sama muoto, vakaa koodi ja ihmiselle tarkoitettu viesti. Mikään reitti ei keksi omaa tapaansa olla tyytymätön.
Cursor-sivutus
Ei offseteja. Lista, joka muuttuu sen aikana kun kuljet sitä, ei hiljaa ohita tai toista rivejä, kuten offset-sivutus tekee hiljaisesti ja jatkuvasti.
Idempotenssiavaimet
Jokaisella muokkaavalla reitillä. Uudelleenyritys pyynnöstä, jonka perille tulosta et ole varma, antaa saman vastauksen toisen kontaktin, toisen kampanjan tai toisen lähetyksen sijaan.
Rajattu projektiin
Tunnus osoittaa yhtä aikaa yhden tenantin ja yhden projektin. Rivitason tietoturva valvotaan itse tietokannassa, ei sillä, että muistat lisätä ehdon.
Lähtevät webhookit
Allekirjoitettu, uudelleenyritys exponenssilla ja toimitettu vähintään kerran — joten endpointtisi kannattaa olla myös idempotentti. Tapahtumat käyttävät samaa sanastoa kuin raportit.
Poisto ja vienti
Yhteyshenkilön voi viedä tai poistaa API:n kautta, ja poisto etenee jokaiseen sisarpalveluun, jolla on kopio, perheen omaa sisäistä kanavaa pitkin.
Kaiken mitä käyttöliittymä osaa, POST osaa.
Tapahtumat ovat kiinnostavin osa
Kaikki muu tällä sivulla on odotettavissa olevaa putkistoa. POST /v1/events on reitti, joka muuttaa sen, mihin tuotetta käytetään.
Sovelluksesi tietää jo asioita, joita mikään markkinointityökalu ei voi havaita: kuka saattoi onboardingin loppuun, kuka kutsui kollegan, kuka törmäsi rajaan, kuka vie datansa sunnuntai-iltapäivänä. Lähetä ne tapahtumina omalla tunnuksellasi, ja jokaisesta tulee laukaisin, ehto ja segmentti.
Loput seuraavat yhteyshenkilömallista. Tapahtumat vain lisätään, ei koskaan muokata; ne ovat loki, johon koko tuote nojaa. Tapahtumaan, jonka itse määrittelit, lauhtuva suppilo ei ole integraatio — se on sama mekanismi, jota message_opened käyttää, vain eri nimellä.
- 1Lähetät sen
POST /v1/events— nimi, yhteyshenkilö, payload ja idempotenssiavain. - 2Se saapuuSe lisätään yhteyshenkilön lokiin. Muun ei tarvitse tietää sen olemassaolosta.
- 3Suppilo käynnistyyMikä tahansa suppilo, jonka aloitus mainitsee kyseisen tapahtuman, kenelle tahansa sen aloitusehdon täyttävälle yhteyshenkilölle.
- 4Muut suppilot haarautuvat siitä"Onko tämä tapahtuma sattunut viimeisen 14 päivän aikana" on tavallinen segmenttiehto.
- iJa se päättää ajotSamaa tapahtumaa nimeävä tavoitesolmu pysäyttää sekvenssin sillä hetkellä, kun henkilö tekee asian.
Sinun sanastosiTunnuksesi
Rajat, jotka kannattaa tuntea ennen rakentamista
ClickSomo tallentaa sinusta kolme tunnistetta — tenantin, projektin ja käyttäjän, läpinäkymättöminä id:inä — eikä mitään muuta. Ei salasanaa, ei profiilia, ei korttia, ei laskua. Suunnitelman rajat tulevat lukuina: montako yhteyshenkilöä, montako lähetystä, montako generointia. Maksusanasto ei ylitä tätä rajaa kumpaankaan suuntaan.
Yhteyshenkilösi ovat sinun. Sinä olet rekisterinpitäjä; me olemme käsittelijä. Ei ole reittiä, jota pitkin perheen toinen tuote voisi lukea tai kirjoittaa yhteyshenkilölistaasi, eikä yhtään syöttökanavaa sille.
Jos arvioit tätä tosissaan: lue /docs ennen kuin luet lisää tätä sivustoa. API on rehellinen kuvaus siitä, mitä tuote tekee, ja jokainen näiden sivujen väite vastaa sieltä löytyvää reittiä tai solmutyyppiä. Kun skeema muuttuu, nämä sivut muuttuvat.