Ny API

Tsy misy endpoint manokana. Na dia ho an'ny interface aza.

Ny vokatra maro dia manana API roa: ny iray voasoratra omena anao, ary ny iray mahaliana ampiasain'ny efijery manokana. Ny faharoa no tsara kokoa foana, ary tsy mahazo manatona azy mihitsy ianao. Eto dia iray ihany no misy, ary ny interface dia mpanjifa azy toy ny hafa rehetra — izany dia famerana ho anay, ary ny antony mahatonga ny zava-drehetra tianao hatao ho azo atao.

Ny vidin'io fitsipika io marina

Midika izany fa indraindray ny efijery dia mila miandry ny API ho marina, fa tsy mandalo azy haka saha iray mahasoa. Ny andro ilain'ny efijery zavatra tsy omen'ny API ampahibemaso no andro diso ny API, ary ny fanitsiana dia ny API.

Ny tombontsoa dia fa mpanjifa telo samihafa be dia be dia tsy mila ezaka fanampiny. Ny MCP server dia mpanjifa. Tile dash-b iray dia mpanjifa. Ny script-nao dia mpanjifa. Tsy misy azy ireo olona ambany laharam-pahamehana miady amin'ny tany natao ho an'ny hafa, satria tsy misy tany hafa hahatonga azy ho ambany.

Voasoratra, ary nozahana

OpenAPI dia vokarina ao amin'ny /docs ary ny lalana tsirairay dia manana test izay ohatra ao amin'ny antontan-taratasy. Antontan-taratasy nosoratana misaraka amin'ny code dia mihalefona ao anatin'ny iray volana; antontan-taratasy mipoaka ny build raha diso tsy mihalefona.

Fidirana

Ny kaonty castomo-nao, amin'ny alalan'ny authorization code flow miaraka amin'ny PKCE — ny kaonty iray ihany ampiasainao ho an'i dash-b sy ny hafa ao amin'ny fianakaviana. Pejy tsy manana server manokana dia mahatanteraka io flow io tsara; io no natao azy. Ho an'ny asa machine-to-machine, API key voafetra amin'ny tetikasa.

Ny tanyapi.clicksomo.com

1Olona/v1/contacts · /lists · /segments · /tags · /imports
2Votoatiny/v1/creatives, miaraka amin'ny fanamarinana, topimaso ary render isaky ny tanjona
3Fampandehanana ho azy/v1/funnels · /funnels/:id/versions · /runs · /simulate
4Fampitana/v1/campaigns, miaraka amin'ny audience, materialise, fandaharana ary fandefasana ho dingana samihafa
5Zava-mitranga miditra/v1/events — zava-mitranga amin'ny rindrambaikinao, ho triggers
6Fandefasana/sender-identities · /domains · /apps · /webhooks
7Isa/v1/reports/*, ary /track/* amin'ny mpampiantrano fanaraha-maso

OpenAPI ao amin'ny /docs/mcp amin'ny process iray ihany

Fomba fanao

Ny endrika iray amin'ny service castomo hafa rehetra

Izany no zava-dehibe kokoa noho ny toa izany. Raha efa miantso iray amin'ireo ianao, dia efa fantatrao ny fomba valiny, fahadisoana ary pagination ataon'ity.

Envelope diso iray

Ny fahadisoana tsirairay dia manana endrika iray ihany, code milamina ary hafatra natao ho an'ny olona. Tsy misy lalana mamorona fomba manokana hanehoana fahatezerana.

Pagination amin'ny cursor

Tsy offsets. Lisitra miova mandritra ny fandehananao azy dia tsy mitsambikina na miverina andalana tsy misy fampandrenesana, izay ataon'ny pagination amin'ny offset amim-pahanginana sy tsy tapaka.

Idempotency keys

Amin'ny lalana manova rehetra. Avereno ny fangatahana tsy azo antoka fa tonga dia mahazo valiny iray ihany fa tsy contact faharoa, hetsika faharoa na fandefasana faharoa.

Voafetra amin'ny tetikasa

Ny token iray dia mba manondro tenant iray sy tetikasa iray, samy izy roa. Ny fiarovana ambaratonga-andalana dia voataonana ao amin'ny angona mihitsy, fa tsy amin'ny fahatsiarovana hanampy fehezanteny.

Webhooks mivoaka

Voasonia, averina atao miaraka amin'ny backoff, ary alefa indray mandeha farafahakeliny — ka ny endpoint-nao dia tokony ho idempotent koa. Ny hetsika dia ny voambolana mitovy amin'ny ampiasain'ny tatitra.

Famafana sy fanafarana

Ny contact iray dia azo alaina na voafafa amin'ny alalan'ny API, ary ny famafana dia mahatratra ny serivisy rahavavy rehetra nanana kopia amin'ny alalan'ny lalana anatiny an'ny fianakaviana.

Ny zava-drehetra azon'ny interface atao, azon'ny POST atao.

Ny hetsika no ampahany mahaliana

Ny sisa rehetra eto amin'ity pejy ity dia fitaovana fototra efa nantenainao. Ny POST /v1/events no lalana manova ny antony iantenan'ny vokatra.

Efa fantatry ny rindrambaikonao ny zavatra tsy hitan'ny fitaovana marketing rehetra: iza no nahavita ny onboarding, iza no nampiantso namana, iza no nahatratra fetra, iza no naka ny angony amin'ny alahelo. Alefaso izy ireo ho hetsika miaraka amin'ny token-nao, ary ny tsirairay dia lasa trigger, fepetra ary segment.

Ny sisa dia manaraka avy amin'ny modelin'ny contact. Ny hetsika dia ampidirina, tsy ovaina; izy ireo no log itoheran'ny vokatra manontolo. Ny funnel mipoitra amin'ny hetsika nolazainao dia tsy integration — dia ny mekanisma mitovy amin'ny an'ny message_opened, amin'ny anarana hafa ao anatiny.

Ny hetsikao dia lasa funnelapi_event

1Ianao no mandefa azyPOST /v1/events — anarana iray, contact iray, payload iray, fanalahidin'ny idempotency iray.
2TongatraAmpidirina ao amin'ny log an'ny contact. Tsy misy hafa mila mahalala fa misy izy.
3Misy funnel manombokaNy funnel rehetra izay miantso io hetsika io ao amin'ny fidirany, ho an'ny contact rehetra mahazo araka ny spec fidirany.
4Ny funnels hafa mizara amin'izy"Nisy ve io hetsika io nandritra ny 14 andro farany" dia predicate segment tsotra.
iAry mamarana ny runsNy node tanjona miantso ny hetsika mitovy dia manakana sequence avy hatrany rehefa manao ny zava-drehetra ny olona.

Ny voambolananaoNy token-nao

Ny fetra tokony ho fantatra alohan'ny hanangananao

Mitatitra identifiers telo momba anao ny ClickSomo — tenant iray, tetikasa iray ary mpampiasa iray, amin'ny endrika ids tsy mazava — ary tsy inona hafa. Tsy tenimiafina, tsy profil, tsy karatra, tsy faktora. Ny fetran'ny plan dia tonga ho isa: firy ny contacts, firy ny fandefasana, firy ny generations. Ny voambolan'ny fandoavam-bola tsy mandalo io sisiny io amin'izay tondro.

Ny contacts-nao dia anao. Ianao no data controller; izahay no processor. Tsy misy lalana ahafahan'ny vokatra hafa ao amin'ny fianakaviana mamaky na manoratra ny lisitry ny contacts-nao, ary tsy misy lalana ingest azo ampiasain'ny iray.

Raha mandinika izy tsara ianao: vakio ny /docs alohan'ny hamaky bebe kokoa amin'ity tranonkala ity. Ny API no famaritana marina ny ataon'ny vokatra, ary ny filazana rehetra eto amin'ireo pejy ireo dia mifandray amin'ny lalana na karazana node hitanao ao. Rehefa miova ny schema, miova koa ireo pejy ireo.