An API
Nyns eus pennfenwel privet. Ny's teves rag an ynterfas vyth.
Meur a dhylow a's teves dew API: an onan kovadhwys a's teves offerys dhys, hag an onan yntanessa usys gans aga skrinyow aga honan. An nessa yw pupprys gwell, ha ny's teves vyth kummyas ogas dhodho. Omma yma onan, hag an ynterfas yw klient anodho kepar ha tra vyth aral — hemma yw kemmyniwarnans warnan ny, ha'n resenn a wra pup tra a vynnydhys drehevel kadow.
Py arweth yn hwir a wra an rewl ma kostya
Y styry henna bos skrin yn eylweyth owth assosya rag an API bos ewn, kyns es hy drehedhes a-dro dhodho rag onan prys meur a les. An dydh may hyv skrin tra ny's teves an API kowal hy roev yw an dydh mayth yw an API kamm, ha'n gorthybyans yw an API.
An gobra yw bos tri klient pur dhifrans ow kostya ogas ny's teves tra keworryes. An servyer MCP yw klient. Tilek dash-b yw klient. Agas skrypt agas honan yw klient. Ny's teves onan anedha avel was den nessa a wra ober a-dro dhe'nep enep gwrys rag den aral, rag ny's teves enep aral dhe vos nessa dhodho.
Kovadhwys, ha gwrys usi
OpenAPI yw generys yn /docs hag pub fordh a's teves prov a'n ensampel yn an kovadhow. Kovadhow skrifys dyworth an kod yn aral a's teves fygys yn mis; kovadhow a fyll an drehevyans pan wons kamm ny wra.
Omgelmi
Agas kont castomo, dre an fros kod awtorita gans PKCE — an keth kont a's teves usys rag dash-b ha'n remena a'n teylu. Folenn heb servyer a's honan a wra an fros na yn da lowr; henn yw pyth o an fros gwrys rag. Rag ober jynn-dhe-jynn, alhwedh API gwrys rag an towl.
- 1Tus
/v1/contacts·/lists·/segments·/tags·/imports - 2Dalgh
/v1/creatives, gans validyans, ragwel ha render yn pub golok - 3Otomatieth
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Darlesans
/v1/campaigns, gans poblek, materiel, amserlen ha danvon avel gweythresow dyffrans - 5Hwarvosow ynn
/v1/events— hwarvosow agas arwias agas honan, avel triggyow - 6Dylans
/sender-identities·/domains·/apps·/webhooks - 7Niverow
/v1/reports/*, ha/track/*yn an ost holans
OpenAPI yn /docs/mcp yn an keth argerdh
Konvedhys
An keth furv avel pub servys castomo aral
Henn a's teves moy a boos es y klywes. Mar te's teves sonyow dyworth onan anedha sew, te's teves sonyow sowth howk an onan ma a gorthyb, a fyll ha folenn.
Onan gortys gwall
Pub fyll a's teves an keth furv, kod fast ha gorthyp gwrys rag den. Ny's teves fordh a wra hy fordh hy honan a vos anwhes.
Folenn cursor
Ny's teves offsetow. Rol a's teves chanjys pan's teves hy gerghes ny's teves hwath linyow skonya po daswul yn taw, pyth a wra folenn offset yn taw ha pub prys.
Alhwedhow idempotent
Yn pub fordh chanjya. Dasgylgh pedyans nag yw sure a dhisken ha kavos an keth gorthyp kyns es an nessa kontak, an nessa kampan po an nessa danvon.
Gwrys rag onan towl
Token a's teves onan tenant hag onan towl, an dhew. Diogeledh nivel lin yw gwrys yn an database y honan, ny's teves gans kov a geworra klaws.
Webhooks yn-mes
Sinys, dasgylghys gans backoff, ha dyllys oll leshan onan — ytho agas pennfenwel a dal bos idempotent ynwedh. An hwarvosow yw an keth geryow a's teves usys gans an derivadow.
Dilea ha diworthkas
Kontakt a's teves diworthkys po dileys dre an API, ha dilea a dhrehedh pub servys breder a's teves kopí dre lann an teylu y honan.
Pub tra an ynterfas a's teves gallos, POST a's teves gallos.
An darvosow yw an rann a les
Pub tra arall war an folen ma yw plominyans a wortosowgh. POST /v1/events yw an fordh a janj pyth yw an gwruthys rag.
Agas arwodh a wodhvyo dyllans ny yll towl argerdhe weles: pi a worfennas onboarding, pi a gemeras kowetha, pi a dhinys limyt, pi a eksportyas aga data dy' Sul an gorthugher. Postys an re na avel darvosow gans agas tokenn agas honan, ha pub onan a dhos ha bos trigger, studh ha segment.
An remenant a sywedh dhyworth an model kuntak. Darvosow yw kevrennys, ny vons skrifys arta; i yw an kovnotenn may krog an oll gwruthys warni. Fynnel a dhrehedh war darvos gansowgh definys nyns yw kesunyans — yw an keth jynn message_opened a wra devnydh anodho, gans hanow dyffrans ynno.
- 1Ty a wra postya
POST /v1/events— hanow, kuntak, payload, alhwedh idempotency. - 2Y tevickKevrennys dhe govnotenn an kuntak. Ny vynn pyth arall godhvos y vos.
- 3Fynnel a dhallathPub fynnel may hanow entry an darvos na, rag kuntak vyth gwiys yn-dann y entry spec.
- 4Fynnelow erel a brann warno"A wrug an darvos ma hwarvos yn-dann an 14 dydh diwettha" yw predyk segment usadow.
- iHa gwriansow a worfenNod gol a hanwel an keth darvos a hedh sequens an termyn may kul an den an tra.
Agas gerlewAgas tokenn
Meryow gwiys godhvos kyns gul devnydh
ClickSomo a with tri identifer a-dro dhywgh — tenant, project ha user, avel ids opak — ha ny vyth tra vyth. Na password, na profil, na kard, na invoice. Limitys plan a dhevick avel niverow: py niver a guntakow, py niver a dhanvon, py niver a henerations. Gerlew payans ny treuslinen an linen na yn py tu bynnag.
Agas kuntakow yw agasowgh. Ty yw an data controller; ni yw an processor. Nyns eus fordh may yll gwruthys arall yn an teylu redya po skrifa agas rol kuntak, ha nyns eus ingest lane rag onan dhe wul devnydh anodho.
Mars esowgh ow muska an dra yn tiw: redyowgh /docs kyns redya moy a'n gwiasva ma. An API yw an deskrifans onest a wra an gwruthys, ha pub klaim war an folennow ma a wra map dhe fordh po eghen nod y hyllir kavos ena. Pan janj an schema, an folennow ma a janj.