API
Nta muri yihariye uhishwe. Ntagake kuri interface.
Ibicuruzwa byinshi bifite API ebyiri: iyo yanditsemu ibyerekeye ibyavuzwe, n'iyo nyayo ikoreshwa ku paji zabyo. Iya kabiri ni nziza kurusha iyindi, kandi nta gihe ubemererwa kuyigeraho. Hano hari imwe gusa, kandi interface ni umukiriwayo wayo nk'ikindi cyose — ibi ni ingomba kuri twe, kandi ni cyo gituma ibyo ushaka kubaka byose bishoboka.
Ibyo itegeko rigira ku nyungu nyayo
Bisobana ko paji rimwe na rimwe rigomba kureba API igihe ari yo, aho kuyirengaho kubona umwanya umwe woroshye. Umunsi paji rikeneye ikintu API rusange itagira ni umunsi API ari yo iteye, kandi igiciro ni API.
Inyungu ni uko abakiriya batatu batandukanye bidatinze cyane. Server ya MCP ni umukiriya. Tile ya dash-b ni umukiriya. Inyandiko yawe bwite ni umukiriya. Nta wese akora akazi k'urwego rwa kabiri yirengaho ku muryango wagenewe undi, kuko nta muryango undi uhari.
Yanditsemu, kandi ikoreshwa
OpenAPI itunganywa kuri /docs kandi buri nzira ifite igeragezo ari cyo cyagaragaraga mu nyandiko. Inyandiko yandikwa itandukanye n'itangwa yandika mu kwezi; inyandiko ihagarika build iyo ari yo iteye ntabwo yanduka.
Kwinjira
Konti yawe ya castomo, ifitemo authorization code flow na PKCE — konti imwe ukoresha kuri dash-b n'izindi zose mu muryango. Paji idafite server yayo ishyiraaho iryo flow neza cyane; ni cyo cyari cyagenwemo. Ku kazi kwa machine-to-machine, API key y'umushinga.
- 1Abantu
/v1/contacts·/lists·/segments·/tags·/imports - 2Ibirimo
/v1/creatives, hamwe n'igenzura, preview no gukora ku rwego rw'umwanya - 3Automasisiyo
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Gusakaza
/v1/campaigns, hamwe n'abasubizwe, materialise, gushyiraho isaha no kohereza nk'intambwe zitandukanye - 5Ibyabaye bwinjira
/v1/events— ibyabaye muri porogaramu yawe, nk'ibyerekana - 6Kohereza
/sender-identities·/domains·/apps·/webhooks - 7Imibare
/v1/reports/*, na/track/*kuri host y'ikurikirana
OpenAPI kuri /docs/mcp kuri process imwe
Amategeko
Ishusho imwe nk'iyindi service ya castomo yose
Ibi ni byo bidasimbukira uko bisoma. Niba usanzwe wita ku rimwe muri ibi, usanzwe uzi uko iyi isubiza, igwa kandi igabanya urupapuro.
Ikosa rimwe gusa
Buri kosa gifite ishusho imwe, code idahinduka n'ubutumwa bwagenewe umuntu. Nta nzira ivumbura uko yibaza ubwayo.
Kugabanya urupapuro n'urudodo
Atari offsets. Urutonde ruhinduka mu gihe urarimo kurakora ntirukureke cyangwa ntirukongere urutonde, ibyo offset pagination ikora mu buryo buhishwe kandi burambye.
Amabanga yo kubabaza
Ku buri nzira ihindura ikintu. Ongera usabe ubutumwa udashidikajwe ko bwageze kandi ubone igisubizo cya nyuma kimwe aho kuba ubwibutiro bwa kabiri, campaign ya kabiri cyangwa kohereza rya kabiri.
Gifite umushinga umwe
Token ishobora kugera ku tenant imwe n'umushinga umwe, byombi. Row-level security ishyirwa mu ntoki muri database ubwayo, atari kwibuka kongera interuro.
Webhooks zisohoka
Zifite umukono, zongera mu buryo bwa backoff, kandi zoherezwa rimwe rimwe — bityo endpoint yawe igomba kuba idempotent na yo. Ibyabaye ni ijambo rimwe raporo zikoresha.
Gusiba no kwohereja hanze
Uwo ari we wese washobora koherezwa hanze cyangwa gusibwa binyuze kuri API, kandi gusiba kugeraho kuri serivisi zose zari zifite inyandiko yabo binyuze ku nzira y'imbere y'urugo.
Ibyose interface ishobora gukora, POST ishobora kubikora.
Ibyabaye ni iby'ingenzi
Ibindi byose biri kuri iyi paji ni iby'umwuga usanzwe ubona. POST /v1/events ni inzira ihindura icyo umusaruro ugena.
Porogaramu yawe isanzwe ifite amakuru nta cyanya cy'itangazamakuru gishobora kubona: nde yarangiye kwiyandikisha, nde yariyemuriye umunyamuryango, nde yageze ku ngingo, nde yohereje amakuru yewe ku wa gatandatu ku manywa. Yohereze aya nka events ufite token yawe, kandi buri kimwe kigira urugero (trigger), impamvu (condition) n'itsinda (segment).
Ibindi bikurikira biva ku miterere y'abantu. Events zongerwa, ntizigasubirwamo; ni log yose umusaruro wese wumiriraho. Funnel itangira ku event wagena si integration — ni uko message_opened ikora, ariko ifite izina rindwi muri yo.
- 1Uwayihishurira
POST /v1/events— izina, umuntu, payload, idempotency key. - 2IgeraYongerwa ku log y'uwamwoherejwe. Nta kindi gikeneye kumenya ko ihari.
- 3Funnel itangiraFunnel iyo ari yo yose ifite entry ivuga event iyo, kuri buri muntu yemewe n'itsinda rya entry yayo.
- 4Ibindi funnels biyakoresha"Ese event yabaye mu minsi 14 ishize" ni impamvu isanzwe yo mu itsinda.
- iKandi irarangiza runsGoal node ivuga event imwe ihagarika sequence ako kanya umuntu abikoze.
Ubwumenyi bwaweToken yawe
Imipaka y'ingenzi ukeneye kumenya mbere yo kwubaka
ClickSomo ibika uturindantatu (identifiers) ku bijyanye nawe — tenant, project na user, nka ids zidagaragara — n'ibindi byose. Nta password, nta profile, nta kadi, nta invoice. Ngingo z'umushinga ziza nk'ibarura: abantu bangahe, ibyoherezwa bingahe, ibyakozwe bingahe. Amagambo yo kwishyura ntabwo yambukiranya uwo mupaka mu mpande zombi.
Abantu bawe ni ibyawe. Uri umugenzuzi w'amakuru (data controller); turi abakora (processor). Nta nzira ihari ifata umusaruro undi mu rugo ashobora gusoma cyangwa kwandika urutonde rw'abantu bawe, kandi nta nzira yo kwinjiza ihari.
Niba usuzuma ibi byukuri: soma /docs mbere y'uko usoma ikindi kintu kuri urubuga. API ni urwandiko rw'ukuri rw'ibyo umusaruro ukora, kandi bivugwa byose kuri aya mapaji bihuye n'inzira cyangwa ubwoko bwa node ushobora kubona. Iyo schema ihindutse, aya mapaji ahinduka.