clickSomo
Mepee ClickSomo

API ahụ

Ọnweghị njedebe nzuzo. Ọbụlagodi maka njikwa ahụ.

Ọtụtụ ngwaahịa nwere API abụọ: nke edere nke ọma nke a na-enye gị, na nke na-adọrọ mmasị nke ihuenyo ha nwere onwe ha na-eji. Nke abụọ na-adịkarị mma karịa, ma ọ naghị ekwe ka ị nso ya. Ebe a, otu nke ahụ dị, ma njikwa ahụ bụ onye ahịa ya dịka ihe ọ bụla ọzọ — nke a bụ mmachi anyị na-edebe, na ihe kpatara na ihe niile ị chọrọ iwu kwere omume.

Iwu ahụ na-efu n'ezie

Ọ pụtara na ihuenyo na-enwe mgbe ụfọdụ ichebe ka API doo ya nke ọma, kama ịgafe ya were otu ubi dị mma. Ụbọchị ihuenyo chọrọ ihe API ọha enweghị ike inye ya bụ ụbọchị API ahụ na-ezighị ezi, ma ndozi ya bụ API ahụ.

Uru ya bụ na ahịa atọ dị iche iche anaghị akwụ ụgwọ ọzọ dị ukwuu. MCP server bụ onye ahịa. Tile dash-b bụ onye ahịa. Edemede gị nke gị bụ onye ahịa. Ọ dịghị onye n'ime ha bụ nwa amaala nke abụọ na-agafe gburugburu ebe a haziri maka onye ọzọ, n'ihi na ọ nweghị ebe ọzọ ịbụ nke abụọ.

Edere nke ọma, ma jiri ya rụọ ọrụ

A na-emepụta OpenAPI na /docs, ma ụzọ ọ bụla nwere ule nke bụ ihe atụ dị na akwụkwọ. Akwụkwọ e dere iche na koodu na-agbanwe n'ime ọnwa; akwụkwọ na-ada mgbe iwu na-ada mgbe ọ na-ezighị ezi anaghị agbanwe.

Ịbanye

Akaụntụ castomo gị, site na usoro nkwenye nke PKCE — otu akaụntụ ị na-eji maka dash-b na ndị ọzọ n'ezinụlọ ahụ. Peeji enweghị onye nlekọta nke ya na-agba usoro ahụ nke ọma; ọ bụ ihe e haziri usoro ahụ maka ya. Maka ọrụ igwe-na-igwe, igodo API nke ọrụ.

Ebe ahụapi.clicksomo.com
  • 1Ndị mmadụ/v1/contacts · /lists · /segments · /tags · /imports
  • 2Ọdịnaya/v1/creatives, na nyocha, nlele anya na ihe osise maka ebe ọ bụla
  • 3Akpaaka/v1/funnels · /funnels/:id/versions · /runs · /simulate
  • 4Mgbasa ozi/v1/campaigns, na ndị na-ege ntị, ihe onwunwe, oge na izipu dịka nzọụkwụ dị iche iche
  • 5Ihe omume na-abata/v1/events — ihe omume ngwa gị nke gị, dịka ihe na-akpali
  • 6Nnyefe/sender-identities · /domains · /apps · /webhooks
  • 7Nọmba/v1/reports/*, na /track/* na onye nlekọta nsochi

OpenAPI na /docs/mcp na otu usoro

Omenala

Ọdịdị ahụ dịka nke ọrụ castomo ọ bụla ọzọ

Nke a dị mkpa karịa ka ọ na-ada. Ọ bụrụ na ị na-akpọ otu n'ime ndị a, ị maara otu nke a si zaa, daa ma ọ bụ gosipụta peeji.

Otu akpa njehie

Ọdịda ọ bụla nwere otu ọdịdị, koodu kwụsiri ike na ozi e mere maka onye. Ọ nweghị ụzọ na-emepụta ụzọ ya nke ịnwaọ.

Nchịkọta peeji nke cursor

Ọ bụghị offsets. Ndepụta na-agbanwe mgbe ị na-eje ya anaghị eziga ma ọ bụ megharịa ahịrị n'enweghị ihe ọ bụla, nke offset pagination na-eme n'ụzọ nzuzo mgbe niile.

Igodo idempotency

Na ụzọ ọ bụla na-agbanwe ihe. Gbalịa arịrịọ ị naghị amata ma ọ rutela ma nweta otu azịza kama njikọ nke abụọ, mkpọsa nke abụọ ma ọ bụ izipu nke abụọ.

E kpebiri ya na ọrụ

Token na-ezo aka na otu onye nwe na otu ọrụ, ha abụọ. Nchekwa ọkwa ahịrị na-eme n'ime nchekwa data n'onwe ya, ọ bụghị site na icheta ịgbakwụnụ nkebi ahịrị.

Webhooks na-apụ

E bịara aka, e nwaleghachiri ya na nkwụsị nke na-abawanye, e nyekwara ya opekata mpe otu ugboro — ya mere njedebe gị kwesịrị ịbụ nke idempotent. Ihe omume ndị a bụ otu okwu ndị akụkọ na-eji.

Ihichapụ na mbupụ

Enwere ike mbupụ ma ọ bụ ihichapụ onye kọntaktị site na API, na ihichapụ ahụ na-eru ọrụ nwanne ọ bụla nwere otu nke site na ụzọ dị n'ime ezinụlọ ahụ.

Ihe niile njikwa ahụ nwere ike ime, POST nwere ike ime ya.

Ihe omume bụ akụkụ na-atọ ụtọ

Ihe niile ọzọ dị na peeji a bụ ọkpụkpụ ị ga-atụle. POST /v1/events bụ ụzọ na-agbanye ihe ngwaahịa ahụ dị maka.

Ngwa gị maara ihe ọ bụla ngwaọrụ ahịa ọ bụla enweghị ike ịhụ: onye rụchara onboarding, onye kpọrọ onye ọrụ ibe ya, onye kụrụ oke, onye mbupụ data ya n'ụtụtụ Sọnde. Zipụ ha dị ka ihe omume na token gị nke gị, ma nke ọ bụla na-aghọ ihe na-akpata, ọnọdụ na nkebi.

Nke fọdụrụ na-esite na ụdị kọntaktị ahụ. A na-agbakwụnye ihe omume, a naghị edezi ha; ha bụ akwụkwọ ndekọ ngwaahịa ahụ dum kwụ n'elu. Funnel na-akpata na ihe omume ị kọwara abụghị njikọta — ọ bụ otu usoro message_opened na-eji, na aha dị iche n'ime ya.

Ihe omume gị na-aghọ funnelapi_event
  • 1Ị zipụ yaPOST /v1/events — aha, kọntaktị, payload, igodo idempotency.
  • 2Ọ na-adaA na-agbakwụnye ya na akwụkwọ ndekọ kọntaktị ahụ. Ọ dịghị ihe ọzọ chọrọ ịma na ọ dị.
  • 3Funnel na-amaliteFunnel ọ bụla nke ntinye ya kpọrọ aha ihe omume ahụ, maka kọntaktị ọ bụla ruru eru n'okpuru ntinye ya.
  • 4Funnels ndị ọzọ na-ekewa na ya"Ihe omume a emeela n'ime ụbọchị 14 gara aga" bụ ihe nyocha nkebi nkịtị.
  • iỌ na-akwụsịkwa ọsọNgalaba ebumnuche na-akpọ aha ihe omume ahụ na-akwụsị usoro ozugbo onye ahụ mere ihe ahụ.

Okwu gịToken gị

Oke ị kwesịrị ịma tupu ị wuo

ClickSomo na-echekwa njirimara atọ gbasara gị — tenant, oru ngo na onye ọrụ, dị ka ids opaque — na ọ dịghị ihe ọzọ. Ọ dịghị okwuntughe, ọ dịghị profaịlụ, ọ dịghị kaadị, ọ dịghị invoice. Oke atụmatụ na-abịa dị ka nọmba: ole kọntaktị, ole mbupụ, ole ọgbọ. Okwu ịkwụ ụgwọ anaghị agafe ahịrị ahụ n'akụkụ ọ bụla.

Kọntaktị gị bụ nke gị. Ị bụ onye na-achịkwa data; anyị bụ onye na-ahazi ya. Ọ dịghị ụzọ onye ngwaahịa ọzọ n'ezinụlọ nwere ike iji gụọ ma ọ bụ dee ndepụta kọntaktị gị, na ọ dịghị ụzọ ingest otu nwere ike iji.

Ọ bụrụ na ị na-enyo enyo nke ọma: gụọ /docs tupu ị gụọ ihe ọzọ na weebụsaịtị a. API bụ nkọwa ziri ezi nke ihe ngwaahịa ahụ na-eme, na nkwupụta ọ bụla na peeji ndị a na-ezo na ụzọ ma ọ bụ ụdị node ị nwere ike ịchọta ebe ahụ. Mgbe schema gbanwere, peeji ndị a na-agbanwe.