clickSomo
Buɗe ClickSomo

API

Babu wata hanyar keɓaɓɓiya. Ba ma ma ga hanyar haɗin gwiwa ba.

Yawancin samfuran suna da API guda biyu: wadda aka rubuta take kuma ake ba ka, da kuma mai ban sha'awa da allunansu suke amfani da ita. Na biyu koyaushe yafi kyau, kuma ba a taba ba ka damar kusa da shi ba. A nan akwai daya kawai, kuma hanyar haɗin gwiwa abokin cinikinta ce kamar kowa — wanda shine takurarmu, kuma dalilin da ya sa duk abin da kake son gina zai yiwu.

Me wannan dokar take kashe da gaske

Yana nufin allo wani lokaci dole ya jira API ta zama daidai, maimakon ya kewaye ta ya ɗauko wani fili mai dacewa kawai. Ranar da allo ke buƙatar abu da API ta jama'a ba za ta iya ba shi ba ita ce ranar da API ta ɓata, kuma gyaran shi ne API.

Amfanin shi ne cewa abokan ciniki uku masu bambanci suna kashe kusan komai ƙari. Uwar garken MCP abokin ciniki ne. Kwalin dash-b abokin ciniki ne. Rubutunka na kansa abokin ciniki ne. Babu wanda daga cikinsu ɗan ƙasa na biyu ne ke kewaye wata hanya da aka tsara ga wani, domin babu wata hanya ta biyu da za a kasance na biyu gare ta.

An rubuta take, kuma ana amfani da ita

Ana samar da OpenAPI a /docs kuma kowace hanya tana da gwaji wanda shine misalin da ke cikin takardun. Takardun da aka rubuta daban da lambar suna canzawa cikin wata; takardun da suka kasa ginin lokacin da suka ɓata ba su canza ba.

Shiga

Asusun castomo naka, ta hanyar kwararar lambar izini da PKCE — asusun daya kake amfani da shi ga dash-b da sauran dangin. Shafi mara uwar garken nasa zai iya gudanar da kwararar da kyau; ita ce abin da kwararar aka tsara shi. Don ayyukan na'ura zuwa na'ura, maɓallin API na keɓance ga aiki.

Hanyarapi.clicksomo.com
  • 1Mutane/v1/contacts · /lists · /segments · /tags · /imports
  • 2Abun ciki/v1/creatives, tare da tabbatarwa, duba gabatowa da kuma nuna kowace manufa
  • 3Aikin atomatik/v1/funnels · /funnels/:id/versions · /runs · /simulate
  • 4Watsawa/v1/campaigns, tare da masu sauraronsa, kayatarwa, tsarawa da aika a matsayin matakai daban
  • 5Abubuwan da suka faru shiga/v1/events — abubuwan da suka faru na aikace-aikacenka naka, a matsayin abin haifarwa
  • 6Isarwa/sender-identities · /domains · /apps · /webhooks
  • 7Lambobi/v1/reports/*, da /track/* a kan mai sa ido

OpenAPI a /docs/mcp a kan tsari ɗaya

Ka'idoji

Siffar ɗaya kamar kowace sauran sabis na castomo

Wanda yafi mahimmanci fiye da yadda yake sauti. Idan ka riga ka kira ɗaya daga cikin waɗannan, ka riga ka san yadda wannan ke amsawa, gazawa da kuma shafi-bayani.

Buɗe kuskure guda

Kowace gazawa tana da siffa ɗaya, lambar tabbatacciya da saƙon da aka nufa ga mutum. Babu hanya da ta ƙirƙira nata hanyar baƙin ciki.

Shafi-bayani na alama (cursor)

Ba sauran ƙidaya ba. Jerin da ke canzawa yayin da kake tafiya da shi ba zai ɓoye ko maimaita layuka ba, abin da shafi-bayani na sauran ƙidaya ke yi a ɓoye kuma akai-akai.

Maɓallan idempotency

A kowace hanya mai canzawa. Sake gwada buƙatar da ba ka tabbata ta isa ba kuma ka sami amsa ɗaya maimakon lamba ta biyu, yaƙin nuna zaɓe na biyu ko aika na biyu.

An keɓance ga aiki

Alama tana magance mai haya ɗaya da aiki ɗaya, duka biyun. Tsaron matakin layin ana tilasta shi a cikin bayanan kanta, ba da tunatar da ƙara sasanti ba.

Webhooks fita

An sa hannu, ana sake gwadawa da jinkirta baya, kuma ana isarwa a kalla sau ɗaya — don haka ƙarshenka ma ya kamata ya zama idempotent. Abubuwan da suka faru suna da ƙamus ɗaya da rahotanni ke amfani da shi.

Goge da fitarwa

Ana iya fitar da lamba ko goge ta ta hanyar API, kuma gogewa ta kai ga kowane sabis na 'yan'uwa wanda ya riƙe kwafinta ta hanyar tashar cikin gida ta iyalin.

Duk abin da kebentin zai iya yi, POST zai iya yi.

Abubuwan da suka faru su ne bangaren mai ban sha'awa

Duk sauran abubuwa a wannan shafi bututu ne da za ka yi tsammani. POST /v1/events ita ce hanyar da ke canza abin da samfurin ke nufi.

Aikace-aikacenka ya riga ya san abubuwan da babu kayan aikin talla da zai iya lura da su: wanda ya kammala shigarwa, wanda ya gayyaci abokin aiki, wanda ya kai ga iyaka, wanda ya fitar da bayanansa da yamma Lahadi. Ka tura su a matsayin abubuwan da suka faru da alamarka, kuma kowanne ya zama abin kunnawa, sharadi da rukuni.

Sauran sun biyo daga tsarin lamba. Ana ƙara abubuwan da suka faru, ba a gyara su ba; su ne rajin da dukan samfurin ya ratara. Hanyar da ke kunna ta hanyar abin da ka ayyana ba haɗakarwa ba ce — ita ce dabilar message_opened ɗaya, da suna daban a ciki.

Abin da ya faru naka ya zama hanyarapi_event
  • 1Kana turawaPOST /v1/events — suna, lamba, nauyi, maɓallin idempotency.
  • 2Ya isaAna ƙara shi ga rajin lamba. Babu wani abu da ya kamata ya san cewa yana nan.
  • 3Hanya tana farawaKowace hanya wadda shigarta ta ambaci wannan abu, ga kowace lamba mai cancanta a ƙarƙashin ka'idar shigarta.
  • 4Sauran hanyoyi sun rabu a kanta"Shin wannan abu ya faru a cikin kwana 14 da suka wuce" al'ada ce ta yau da kullun ta rukuni.
  • iKuma yana ƙarewa guduNode manufa mai ambacin wannan abu tana tsayar da jerin nan da nan da mutum ya yi abin.

KamusankaAlamarka

Iyakoki da ya kamata ka sani kafin ka gina

ClickSomo tana adana masu gano uku game da ke — mai haya, aiki da mai amfani, a matsayin ids marasa fahimta — ba wani abu ba. Babu kalmar sirri, babu bayanin martaba, babu kati, babu lissafin biya. Iyakokin shirin suna zuwa a matsayin lambobi: nawa ne lambobi, nawa ne aika, nawa ne samarwa. Ƙamusun biya ba ya ketare wannan layi a ko wanne bangare.

Lambobinka naka ne. Kai ne mai kula da bayanai; mu ne masu aiwatarwa. Babu hanyar da wani samfurin a cikin iyalin zai iya karantawa ko rubuta jerin lambobinka, kuma babu tashar shigarwa daya za ta iya amfani da ita.

Idan kana kimanta wannan da gaske: karanta /docs kafin ka karanta wani ƙarin abu daga wannan gidan yanar gizon. API ce kwatancin gaskiya na abin da samfurin ke yi, kuma kowace da'awa a waɗannan shafuna tana da alaƙa da hanyar ko nau'in node da za ka samu a can. Lokacin da tsarin ya canza, waɗannan shafuna suna canzawa.