Ang API

Walang pribadong endpoint. Kahit para sa interface.

Karamihan sa mga produkto ay may dalawang API: ang naka-dokumentong iniaalok sa iyo, at ang kakaibang ginagamit ng kanilang sariling mga screen. Palaging mas mahusay ang pangalawa, at hindi kailanman pinapalapit sa iyo. Dito ay may isa, at ang interface ay isang client nito na parang iba pa — isang hadlang ito sa amin, at ang dahilan kung bakit posible ang lahat ng gusto mong buuin.

Ano talagang nagagastos ng panuntunang iyon

Nangangahulugan ito na kung minsan ay kailangang maghintay ng isang screen hanggang maging tama ang API, sa halip na lumusot dito para sa isang maginhawang field. Ang araw na kailangan ng isang screen ng bagay na hindi kayang ibigay ng pampublikong API ay ang araw na mali ang API, at ang ayos ay ang API.

Ang kabayaran ay ang tatlong napakaiibang client ay halos walang dagdag na gastos. Ang MCP server ay isang client. Ang isang dash-b tile ay isang client. Ang iyong sariling script ay isang client. Wala sa kanila ang second-class citizen na lumulusot sa isang surface na dinisenyo para sa iba, dahil walang ibang surface na maaaring pangalawa.

Naka-dokumento, at ginagamit

Ginagawa ang OpenAPI sa /docs at bawat ruta ay may test na siyang halimbawa sa dokumentasyon. Ang dokumentasyong isinulat nang hiwalay sa code ay lumilihis sa loob ng isang buwan; ang dokumentasyong bumabagsak sa build kapag mali ay hindi.

Pag-sign in

Ang iyong castomo account, sa authorization code flow na may PKCE — ang parehong account na ginagamit mo para sa dash-b at iba pa ng pamilya. Ang isang pahina na walang sariling server ay tumatakbo nang maayos ng flow na iyon; iyon ang dinisenyo ng flow. Para sa machine-to-machine na gawain, isang project-scoped API key.

Ang surfaceapi.clicksomo.com

1Mga Tao/v1/contacts · /lists · /segments · /tags · /imports
2Nilalaman/v1/creatives, na may validation, preview at render bawat target
3Awtomasyon/v1/funnels · /funnels/:id/versions · /runs · /simulate
4Pagsasahimpapawid/v1/campaigns, na may audience, materialise, schedule at send bilang magkakaibang mga hakbang
5Mga event na papasok/v1/events — mga event ng sarili mong application, bilang mga trigger
6Paghahatid/sender-identities · /domains · /apps · /webhooks
7Mga Numero/v1/reports/*, at /track/* sa tracking host

OpenAPI sa /docs/mcp sa parehong proseso

Mga Kombensyon

Ang parehong hugis tulad ng bawat iba pang serbisyo ng castomo

Mahalaga ito nang higit sa tunog nito. Kung tumatawag ka na sa isa sa mga ito, alam mo na kung paano sumasagot, nagkakamali at nag-paginate ang ganito.

Isang envelope ng error

Ang bawat pagkabigo ay may parehong hugis, isang matatag na code at isang mensahing nakalaan sa tao. Walang ruta na gumagawa ng sarili nitong paraan ng pagdadalamhati.

Cursor pagination

Hindi offsets. Ang listahang nagbabago habang nilalakad mo ito ay hindi tahimik na lumalaktaw o umuulit ng mga row, na tahimik at walang tigil na ginagawa ng offset pagination.

Mga idempotency key

Sa bawat ruta na nagbabago ng datos. Ulitin ang kahilingang hindi ka siguradong nakarating at makakakuha ka ng parehong sagot sa halip na pangalawang contact, pangalawang campaign o pangalawang pagpapadala.

Saklaw ng isang proyekto

Isang token ang tumutukoy sa isang tenant at isang proyekto, pareho. Ang row-level security ay ipinatupad mismo sa database, hindi sa pag-alalang magdagdag ng clause.

Mga papalabas na webhook

Pirmado, inuulit na may backoff, at inihahatid nang hindi bababa sa isang beses — kaya dapat idempotent din ang endpoint mo. Ang mga event ay ang parehong bokabularyong ginagamit ng mga report.

Pagbura at pag-export

Ang isang contact ay maaaring i-export o burahin sa pamamagitan ng API, at ang pagbura ay umaabot sa bawat kapatid na serbisyong may kopya sa pamamagitan ng panloob na daloy ng pamilya.

Lahat ng kayang gawin ng interface, kayang gawin ng POST.

Ang mga event ang kawili-wiling bahagi

Ang lahat ng iba pa sa pahinang ito ay plomerong inaasahan mo na. Ang POST /v1/events ang rutang nagbabago ng layunin ng produkto.

Ang application mo na ay may alam na mga bagay na hindi kayang obserbahan ng anumang marketing tool: kung sino ang natapos sa onboarding, kung sino ang nag-imbita ng kasamahan, kung sino ang tumama sa limitasyon, kung sino ang nag-export ng datos nila nang hapon ng Linggo. I-post ang mga ito bilang mga event gamit ang sarili mong token, at ang bawat isa ay magiging isang trigger, isang kondisyon at isang segment.

Ang natitira ay sumusunod sa modelo ng contact. Ang mga event ay idinaragdag, hindi kailanman iniedit; sila ang log na nakasabit ang buong produkto. Ang isang funnel na nagti-trigger sa event na tinukoy mo ay hindi isang integration — ito ang parehong mekanismong ginagamit ng message_opened, na may ibang pangalan lang sa loob.

Ang event mo ay nagiging isang funnelapi_event

1I-post mo itoPOST /v1/events — isang pangalan, isang contact, isang payload, isang idempotency key.
2Dumarating itoIdinaragdag sa log ng contact. Walang iba pang kailangang malaman na umiiral ito.
3Nagsisimula ang isang funnelAnumang funnel na binabanggit ng entry ang event na iyon, para sa anumang contact na karapat-dapat sa ilalim ng entry spec nito.
4Sangâ ang ibang mga funnel ditoAng "Nangyari ba ang event na ito sa nakalipas na 14 araw" ay isang ordinaryong segment predicate.
iAt tinatapos nito ang mga takboAng isang goal node na binabanggit ang parehong event ay humihinto sa isang sequence sa sandaling ginawa ng tao ang bagay.

Ang bokabularyo moAng token mo

Mga hangganan na dapat malaman bago ka magsimula

Nagtatabi ang ClickSomo ng tatlong identifier tungkol sa iyo — isang tenant, isang proyekto at isang user, bilang mga opaque na id — at wala nang iba. Walang password, walang profile, walang card, walang invoice. Ang mga limitasyon ng plano ay dumarating bilang mga numero: ilang contact, ilang padala, ilang generation. Ang bokabularyo ng pagbabayad ay hindi tumatawid sa linyang iyon sa alinmang direksyon.

Ang mga contact mo ay sa iyo. Ikaw ang data controller; kami ang processor. Walang daan kung saan maaaring basahin o baguhin ng ibang produkto sa pamilya ang iyong listahan ng mga contact, at walang ingest lane na magagamit nila.

Kung seryoso kang nag-evaluate nito: basahin muna ang /docs bago magpatuloy sa ibang bahagi ng website na ito. Ang API ang tapat na paglalarawan ng ginagawa ng produkto, at bawat pahayag sa mga pahinang ito ay tumutugma sa isang route o uri ng node na makikita mo roon. Kapag nagbago ang schema, nagbabago rin ang mga pahinang ito.