Y API
Nid oes pwynt pen di-wahân. Nac hyd yn oed ar gyfer y rhyngwyneb.
Mae gan y rhan fwyaf o gynhyrchion ddau API: yr un dogfennu sy'n cael ei gynnig i chi, a'r un diddorol y mae eu sgriniau eu hunain yn ei ddefnyddio. Mae'r ail bob amser yn well, ac nid oes erioed caniatâd i chi agosáu ato. Yma mae un yn unig, a'r rhyngwyneb yn gleient ohono fel unrhyw beth arall — sy'n gyfyngiad arnom ni, a'r rheswm pam y mae popeth rydych chi eisiau ei adeiladu yn bosibl.
Yr hyn y mae'r rheol honno'n ei gostio mewn gwirionedd
Mae'n golygu bod yn rhaid i sgrin weithiau aros i'r API fod yn gywir, yn hytrach na mynd o'i hamgylchynu am un maes cyfleus. Y diwrnod y mae sgrin angen rhywbeth nad yw'r API cyhoeddus yn gallu ei roi yw'r diwrnod y mae'r API yn anghywir, a'r ateb yw'r API.
Y gwarant yw bod tri chleient gwahanol iawn yn costio bron dim yn ychwanegol. Mae'r gweinydd MCP yn gleient. Mae teils dash-b yn gleient. Mae eich sgript eich hun yn gleient. Nid oes unrhyw un ohonynt yn ddinesydd ail-ddosbarth yn gweithio o amgylch arwyneb a ddyluniwyd ar gyfer rhywun arall, oherwydd nid oes arwyneb arall i fod yn ail iddo.
Dogfennu, a'i ddefnyddio
Caiff OpenAPI ei gynhyrchu yn /docs ac mae gan bob llwybr brawf sy'n enghraifft y dogfennaeth. Mae dogfennaeth sy'n cael ei hysgrifennu ar wahân i'r cod yn llusgo o fewn mis; nid yw dogfennaeth sy'n methu'r adeiladu pan fydd yn anghywir yn gwneud hynny.
Mewngofnodi
Eich cyfrif castomo, dros y llif cod awdurdodi gyda PKCE — yr un cyfrif rydych chi'n ei ddefnyddio ar gyfer dash-b a gweddill y teulu. Mae tudalen heb weinydd ei hun yn rhedeg y llif hwnnw'n berffaith; dyna beth y dyluniwyd y llif ar ei gyfer. Ar gyfer gwaith peiriant-i-beiriant, allwedd API sy'n benodol i brosiect.
- 1Pobl
/v1/contacts·/lists·/segments·/tags·/imports - 2Cynnwys
/v1/creatives, gyda dilysu, rhagolwg a rendro fesul targed - 3Awtomeiddio
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Darllediad
/v1/campaigns, gyda chynulleidfa, materialise, amserlennu a hanfon fel camau ar wahân - 5Digwyddiadau i mewn
/v1/events— digwyddiadau eich cais eich hun, fel sbardunau - 6Cyflwyno
/sender-identities·/domains·/apps·/webhooks - 7Rhifau
/v1/reports/*, a/track/*ar y gwesteiwr tracio
OpenAPI yn /docs/mcp ar yr un proses
Confensiynau
Yr un siâp â phob gwasanaeth castomo arall
Sy'n olygu mwy nag y swn. Os ydych chi eisoes yn galw un ohonynt, rydych chi eisoes yn gwybod sut mae'r un hon yn ateb, yn methu ac yn tudalu.
Un amlen gwall
Mae gan bob methiant yr un siâp, cod sefydlog a neges sydd wedi'i bwriadu ar gyfer person. Nid oes unrhyw lwybr yn dyfeisio ei ffordd ei hun o fod yn anhapus.
Tudalu gyda chyrsydd
Dim gwyriadu. Nid yw rhestr sy'n newid wrth i chi ei cherdded yn hepgor nac yn ailadrodd rhesi'n ddistaw, sy'n digwydd yn ddistaw ac yn gyson gyda thudalu gwyriad.
Allweddi idempotens
Ar bob llwybr sy'n newid pethau. Ailgeisiwch gais nad ydych chi'n siŵr a gyrhaeddodd a chael yr un ateb yn hytrach na chyswllt ail, ymgyrch ail neu anfon ail.
Wedi'i gwmpesu i brosiect
Mae tocyn yn cyfeirio at un denant ac un prosiect, y ddau. Diogelwch lefel rhes yn cael ei orfodi yn y gronfa ddata ei hun, nid trwy gofio ychwanegu cymal.
Gwehooks allan
Wedi'u llofnodi, wedi'u hailgeisio gyda backoff, a'u cyflwyno o leiaf unwaith — felly dylai eich pen-bont fod yn idempotent hefyd. Mae'r digwyddiadau'n defnyddio'r un geirfa â'r adroddiadau.
Dileu a allforio
Gellir allforio cyswllt neu ei ddileu trwy'r API, ac mae dileu yn cyrraedd pob gwasanaeth chwaer sy'n dal copi trwy sianel fewnol ei deulu ei hun.
Mae popeth y gall y rhyngwyneb ei wneud, gall POST ei wneud.
Digwyddiadau yw'r rhan ddiddorol
Mae popeth arall ar y dudalen hon yn biblinell y byddech chi'n ei disgwyl. POST /v1/events yw'r llwybr sy'n newid beth mae'r cynnyrch ynddo.
Mae eich cymhwysiad eisoes yn gwybod pethau nad oes unrhyw offer marchnata yn gallu eu gweld: pwy orffenodd ymgynefino, pwy wahoddodd gydweithiwr, pwy darodd ar derfyn, pwy allforodd eu data ar brydnawn dydd Sul. Postiwch y rhain fel digwyddiadau gyda'ch tocyn eich hun, a bydd pob un yn dod yn sbardun, yn amod ac yn segment.
Mae gweddill yn dilyn o'r model cyswllt. Atodir digwyddiadau, byth yn cael eu golygu; nhw yw'r cofnod mae'r cynnyrch cyfan yn dibynnu arno. Nid integreiddiad yw leinen sy'n sbarduno ar ddigwyddiad chi ei ddiffiniodd — mae'n yr un mecanwaith â message_opened, gydag enw gwahanol ynddo.
- 1Rydych chi'n ei bostio
POST /v1/events— enw, cyswllt, llwyth, allwedd idempotency. - 2Mae'n cyrraeddAtodir i gofnod y cyswllt. Does dim angen i unrhyw beth arall wybod ei fod yn bodoli.
- 3Mae leinen yn dechrauUnrhyw leinen y mae ei mynediad yn enwi'r digwyddiad hwnnw, ar gyfer unrhyw gyswllt sy'n gymwys o dan ei manyleb mynediad.
- 4Mae leinennau eraill yn canghennu arnoMae "a yw'r digwyddiad hwn wedi digwydd yn ystod y 14 diwrnod diwethaf" yn rhagdybydd segment arferol.
- aAc mae'n gorffen rhediadauMae nod nodweddi sy'n enwi'r un digwyddiad yn atal dilyniant y foment y mae'r person yn gwneud y peth.
Eich geirfa chiEich tocyn chi
Ffiniau sy'n werth eu gwybod cyn i chi adeiladu
Mae ClickSomo yn storio tri dynodwr amdanoch chi — tenant, prosiect a defnyddiwr, fel iddyn niwlog — a dim byd arall. Dim cyfrinair, dim proffil, dim cerdyn, dim anfoneb. Mae terfynau'r cynllun yn cyrraedd fel rhifau: sawl cyswllt, sawl anfon, sawl cenhedlaeth. Nid yw geirfa taliadau'n croesi'r ffin honno mewn unrhyw gyfeiriad.
Eich cysylltiadau chi yw eich rhai chi. Chi yw'r rheolydd data; ni yw'r prosesydd. Does dim llwybr y gall cynnyrch arall yn y teulu ddarllen neu ysgrifennu eich rhestr cysylltiadau trwyddo, a dim sianel llyncu i un ei defnyddio.
Os ydych chi'n gwerthuso hyn yn ddifrifol: darllenwch /docs cyn darllen mwy o'r wefan hon. Yr API yw disgrifiad onest o beth mae'r cynnyrch yn ei wneud, ac mae pob hawliad ar y tudalennau hyn yn cyfateb i lwybr neu fath o nod y gallwch ei ganfod yno. Pan fydd y sgema'n newid, mae'r tudalennau hyn yn newid.