API náà
Kò sí ibi ìkànnì ìkọ̀kọ̀. Kò sí fún ojú-ìṣàfihàn náà náà.
Púpọ̀ nínú àwọn ọjà ní API méjì: èyí tí a ṣe ìwé fún tí a fi fún ọ́, àti èyí tí ó ní ìfẹ́ tí àwọn ojú-ìṣàfihàn wọn fúnra wọn ń lo. Èkejì máa ń dára jù, ìwọ sì kò ní àṣẹ láti fọwọ́ kàn án rárá. Ní ibí, èyí kan ṣoṣo wà, àti pé ojú-ìṣàfihàn náà jẹ́ oníbárà rẹ̀ bí ohunkóhun mìíràn — èyí jẹ́ ìdénà fún wa, ó sì jẹ́ ìdí tí gbogbo ohun tí ìwọ fẹ́ kọ ṣe ṣeé ṣe.
Ohun tí òfin yìí fi ọwọ́ ra gidi
Ó tumọ̀ sí pé ojú-ìṣàfihàn kan máa ń dúró nígbà míìràn kí API tó tọ́, kí kò gbé ọ̀nà yìí kọjá láti gba ọ̀kan pàtàkì. Ọjọ́ tí ojú-ìṣàfihàn bá nilò ohun tí API àárín gbùngbùn kò lè fún ni ọjọ́ tí API náà kò tọ́, àti ìtúnjú náà ni API.
Ère tí ó wà ni pé àwọn oníbárà mẹ́ta tí ó yàtọ̀ púpọ̀ kò ní owó àfikún tí ó pọ̀. Sáfá MCP jẹ́ oníbárà. Tílẹ́ dash-b kan jẹ́ oníbárà. Ìwé-ètò tirẹ̀ jẹ́ oníbárà. Ẹ̀yàkẹ́yà kì í ṣe ará ìpele kejì tí ń ṣiṣẹ́ yíyí kiri ní àyíká ojú-ìṣàfihàn tí a ṣe fún ẹlòmíràn, nítorí kò sí ojú-ìṣàfihàn mìíràn láti jẹ́ kejì sí.
A ṣe ìwé fún un, a sì fi ṣiṣẹ́
A ń ṣe OpenAPI ní /docs àti pé ọ̀nà kọ̀ọ̀kan ní ìdánwò tí ó jẹ́ àpẹẹrẹ ní ìwé ìṣe. Ìwé ìṣe tí a kọ lọ́nà ìyàtọ̀ láti kódì yóò yí padà láàrin oṣù kan; ìwé ìṣe tí ó ṣìlẹ̀ ìkọ́ ilé nígbà tí ó bá ṣìlẹ̀ kò ní yí padà.
Ìwọle
Àkántì castomo rẹ̀, nípasẹ̀ ìṣe ìṣe ìfúnni àṣẹ pẹ̀lú PKCE — àkántì kan náà tí ìwọ ń lo fún dash-b àti àwọn mìíràn nínú ẹbí náà. Ojú-ewé tí kò ní sáfá tirẹ̀ lè ṣiṣé ìṣe ìfúnni yìí dáadára; ìyẹn ni ohun tí ìṣe ìfúnni náà jẹ́ fún. Fún iṣẹ́ ẹ̀rọ-sí-ẹ̀rọ, bótínnì API tí ó ní ìdègbà iṣẹ́-àkànṣe.
- 1Àwọn ènìyàn
/v1/contacts·/lists·/segments·/tags·/imports - 2Àkóónú
/v1/creatives, pẹ̀lú ìfidi rẹ̀lẹ̀, ìwò àti àwòkọ́ fún àfojúsùn kọ̀ọ̀kan - 3Ìṣe aládàáṣe
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Ìgbóhùnsáfẹ́fẹ́
/v1/campaigns, pẹ̀lú àwọn ènìyàn tí ó ń gbo, ìṣe ohun èlò, ìṣètò àkókò àti ìfiranṣẹ́ bí ìgbésẹ̀ tí ó yàtọ̀ - 5Àwọn ìṣẹ̀lẹ̀ tí ń wọlé
/v1/events— àwọn ìṣẹ̀lẹ̀ ohun èlò tirẹ̀, bí ìkọlu ìṣe - 6Ìfiránṣẹ́
/sender-identities·/domains·/apps·/webhooks - 7Àwọn nọ́mbà
/v1/reports/*, àti/track/*lórí ọ̀gbà ìtọ́sọ́nà
OpenAPI ní /docs/mcp lórí ìṣe ìṣe kan náà
Àwọn ìlànà
Àrà kan náà pẹ̀lú iṣẹ́ castomo kọ̀ọ̀kan mìíràn
Èyí ṣe pàtàkì jù ohun tí ó ń dàgbéré. Bí ìwọ bá ti ń pè ọ̀kan nínú wọn tẹ́lẹ̀, ìwọ ti mọ̀ bí èyí yóò fẹ̀sùn, ṣìlẹ̀, àti ṣe ìpín ojú-iwé.
Àpò àṣìṣe kan ṣoṣo
Ìṣìlẹ̀ kọ̀ọ̀kan ní àrà kan náà, kódì tó dúró dàdà àti ifiṣe tí a ṣe fún ènìyàn. Kò sí ọ̀nà tí yóò ṣe ọ̀nà ìbínú tirẹ̀.
Ìpín ojú-iwé oníkúrúsò
Kì í ṣe ìyípadà. Àkójọ tí ń yípadà nígbà tí ìwọ ń rìn rẹ̀ kò ní fi ọ̀nà àìsọ́ra fọ̀ tàbí tún ẹ̀yà kàn, èyí tí ìpín ìyípadà ń ṣe ní ìkọ̀kọ̀ àti ní ìgbà gbogbo.
Àwọn bọtìnnì ìdàgbàsókè àìyípadà
Lórí gbogbo ònà tó ń yí ohun pádà. Tún bẹ̀rẹ̀ ìbéèrè tí kò bá ti mọ̀ pé ó dé, kí o sì gba ìdáhùn kan náà dípò ìbánisọrọ kejì, ìpolówó kejì tàbí ìfiránṣẹ́ kejì.
Àmì-ìdámọ̀ fún iṣẹ́-àpárò kan
Token kan ń tọ́ka sí tenant kan àti iṣẹ́-àpárò kan, méjèèjì. Ààbò ìwíwò ìwé-oirí ń ṣiṣẹ́ nínu àmì-ìdámọ̀-ìwíwò fúnrárún, kì í ṣe nípa ríantí láti fi ọ̀rọ̀-àsọté kún.
Webhooks jáde
Wọ́n ní àmì-ìdánimọ̀, wọ́n ń tún gbìyànjú pẹ̀lú ìdúrókí, wọ́n sì ń dé ní ìgbà kan tàbí ju bẹ́ẹ̀ lọ — nítorí náà, ohun-èlò ìgbàníyànrán rẹ gbọdọ̀ jẹ́ idempotent. Àwọn iṣẹ́lẹ̀ náà jẹ́ ọ̀rọ̀-ìdánimọ̀ kan náà tí àwọn ìjábọ̀ ń lo.
Ìparí àti ìgbéjáde
A le gbé olùbánisọrọ kan jáde tàbí parẹ́ rẹ̀ nípasẹ̀ API, ìparí sì ń dé ọ̀dọ̀ gbogbo iṣẹ́-àpárò ará tí ó ní ẹ̀dà rẹ̀ nípasẹ̀ ònà inú-ìdílé wọn.
Ohun gbogbo tí ojú-iṣẹ́ lè ṣe, POST lè ṣe ọ̀.
Àwọn iṣẹ́lẹ̀ ni ẹ̀yà tí ó ní ìfẹ́ jùlọ
Ohun gbogbo mìíràn lórí ojú-iṣẹ́ yìí jẹ́ ìpínnu-ìpínnu tí a ń retí. POST /v1/events ni ònà tí ń yí ohun tí ọjà náà jẹ́ fún pádà.
Ohun-èlò rẹ ti mọ̀ nǹkan tí ohun-èlò ìpolówó kò lè rí: ẹni tí ó parí ìkọ́nilẹ̀, ẹni tí ó pè ọ̀rẹ́, ẹni tí ó bá ìdíwọ̀n, ẹni tí ó gbé dátà rẹ̀ jáde ní ọ̀sán Àìkú. Fi wọ́n ránṣẹ́ gẹ́gẹ́ bí iṣẹ́lẹ̀ pẹ̀lú token rẹ, kí ọ̀kọ̀ọ̀kan wọn sì di ìkọlu, ìpètú àti ẹ̀yà kan.
Ìyókù ń bá a lẹ́yìn nítorí àmì-ìdánimọ̀ olùbánisọrọ. A ń fi àwọn iṣẹ́lẹ̀ kún, a kì í ṣàtúnṣe wọ́n; wọ́n ni ìwé-ìtàn tí gbogbo ọjà ń dúró lórí. Fúnnel tí ó ń bẹ́rẹ̀ lórí iṣẹ́lẹ̀ tí o ṣàlàyé kì í ṣe ìsopọ̀ — ọ̀nà kan náà ni message_opened ń lo, pẹ̀lú orúkọ mìíràn nínú rẹ̀.
- 1Ìwọ ń fi ránṣẹ́
POST /v1/events— orúkọ kan, olùbánisọrọ kan, payload kan, bọtìnnì idempotency kan. - 2Ó déA fi kún ìwé-ìtàn olùbánisọrọ náà. Kò sí ohun mìíràn tí ó nílò láti mọ̀ pé ó wà.
- 3Fúnnel kan bẹ́rẹ̀Fúnnel kíkà tí orúkọ ìbẹ̀rẹ̀ rẹ̀ ń tọ́ka sí iṣẹ́lẹ̀ yẹn, fún olùbánisọrọ kíkà tí ó tọ́ lábẹ́ ìpètú ìbẹ̀rẹ̀ rẹ̀.
- 4Àwọn fúnnel mìíràn ń pín lórí rẹ̀"Ṣé iṣẹ́lẹ̀ yẹn ti ṣẹlẹ̀ nínú ọjọ́ 14 ìgbà tí ó kọjá" jẹ́ ìpètú ẹ̀yà ti wọ́n mọ̀.
- iÓ sì parí ìṣẹ̀lẹ̀-ìṣiròNódù goal tí ó ń tọ́ka sí iṣẹ́lẹ̀ kan náà dúró fún ìtẹ̀síwájú ní ìṣẹ́jú tí ẹni náà bá ṣe nǹkan náà.
Ọ̀rọ̀-ìdánimọ̀ rẹToken rẹ
Àwọn àlà tí ó ṣe pàtàkì láti mọ̀ ṣáájú kí o kọ́
ClickSomo ń pa àwọn ìdánimọ̀ mẹ́ta mọ́ fún ọ — tenant kan, iṣẹ́-àpárò kan àti olùmúlò kan, gẹ́gẹ́ bí àwọn id opaque — kò sì sí mìíràn. Kò sí ọ̀rọ̀-ìgbaniwọ̀n, kò sí profaili, kò sí kààdì, kò sí ìwé-owó. Àwọn àlà ètò ń wá gẹ́gẹ́ bí nọ́mbà: iye olùbánisọrọ, iye ìfiránṣẹ́, iye ìpílẹ̀. Ọ̀rọ̀-owó sanfó kò kọjá àlà yẹn ní ọ̀nà méjèèjì.
Àwọn olùbánisọrọ rẹ ti ara rẹ ni. Ìwọ ni olùṣàkóso dátà; àwa ni olùṣe iṣẹ́. Kò sí ònà tí ọjà mìíràn nínú ìdílé lè gbà láti ka tàbí kọ àkójọ olùbánisọrọ rẹ, kò sì sí ònà ìwọ̀-gíga tí ọ̀kan lè lo.
Tí o bá ń gbéyàwó èyí ní ọ̀nà tí ó tọ́: ka /docs ṣáájú kí o tó ka ọ̀kan-òkan mìíràn nínú ojú-ewé yìí. API ni ìṣàpẹ̀jọ́ odidi ohun tí ọjà ń ṣe, àti gbogbo ọ̀rọ̀ tí ó wà ní ojú-ewé wọ̀nyí ń tọ́ka sí ònà tàbí irúe nódù tí o lè rí níbẹ̀. Nígbà tí àmì-ìdánimọ̀ yí padà, ojú-ewé wọ̀nyí ń yí padà.