L-API
M'hemmx endpoint privata. Anki għall-interfaċċa.
Il-biċċa l-kbira tal-prodotti għandhom żewġ APIs: waħda ddokumentata li tiġi offruta, u waħda interessanti li l-iskrins tagħhom stess jużaw. It-tieni dejjem aħjar, u qatt ma jħalluk qribha. Hawn hemm waħda biss, u l-interfaċċa hija klijent tagħha bħal kwalunkwe ħaġa oħra — li hija vincol għalina, u r-raġuni għaliex kull ma trid tibni hu possibbli.
X'inhu t-taħbit reali ta' dak ir-regola
Ifisser li skrin kultant irid jistenna l-API tkun tista' ttejjeb, minflok jaqbbeż għalih għal qasam konvenjent wieħed. Il-jum li skrin jeħtieġ ħaġa li l-API pubblika ma tistax tagħti hu l-jum li l-API tkun ħażina, u s-soluzzjoni hija l-API.
Ir-riżultat hu li tliet klijenti differenti ħafna jiswew kważi xejn żejjed. Is-server MCP hu klijent. Tile ta' dash-b hu klijent. Is-script tiegħek hu klijent. Xejn minnhom mhu ċittadin tat-tieni klassi jaħdem madwar wiċċ mfassal għal xi ħadd ieħor, għax m'hemmx wiċċ ieħor li tkun it-tieni warajh.
Dokumentata, u użata
OpenAPI tiġi ġġenerata f'/docs u kull rotta għandha test li hu l-eżempju fid-dokumentazzjoni. Dokumentazzjoni miktuba separatament mill-kodiċi tinfirel fi żmien xahar; dokumentazzjoni li tonqos il-build meta tkun ħażina ma tagħmilx.
Id-dħul
Il-kont castomo tiegħek, permezz tal-authorization code flow b'PKCE — l-istess kont li tuża għal dash-b u l-bqija tal-familja. Paġna bla server tagħha stess tmur biha tajjeb ħafna; għalhekk ġiet iddisinjata. Għal xogħol machine-to-machine, API key b'skop ta' proġett.
- 1Persuni
/v1/contacts·/lists·/segments·/tags·/imports - 2Kontenut
/v1/creatives, b'validazzjoni, anteprima u render għal kull target - 3Awtomazzjoni
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Xandir
/v1/campaigns, b'udjenza, materialise, skeda u send bħal passi distinti - 5Avvenimenti daħlin
/v1/events— l-avvenimenti tal-applikazzjoni tiegħek stess, bħala triggers - 6Consegna
/sender-identities·/domains·/apps·/webhooks - 7Numri
/v1/reports/*, u/track/*fuq il-host tat-traċċar
OpenAPI f'/docs/mcp fuq l-istess proċess
Konvenzjonijiet
L-istess forma bħal kull servizz ieħor ta' castomo
Li timporta iktar milli jidher. Jekk diġà tsejjaħ wieħed minn dawn, diġà taf kif dan jirrispondi, jonqos u jippaġina.
Envelope ta' żbalji wieħed
Kull falla għandha l-istess forma, kodiċi stabbli u messaġġ mfassal għal persuna. L-ebda rotta ma tinventa triq tagħha stess biex tkun mħassba.
Paġinazzjoni b'cursor
Mhux offsets. Lista li tinbidel waqt li tkun qiegħed timxi fiha ma taqbiżx jew ma tirrepetix ringieli b'mod siekta, li l-paġinazzjoni b'offset tagħha b'mod kostanti.
Kljeċ tal-idempotenza
Fuq kull rotta li tbiddel id-data. Erġa' ibgħat talba li m'intix ċert waslet u ikollok l-istess risposta minflok kuntatt ieħor, kampanja oħra jew send ieħor.
Delimitat għal proġett
Token jindirizza tenant wieħed u proġett wieħed, it-tnejn. Row-level security tiġi infurzata fid-database innifsu, mhux billi tiftakar iżżid klawżola.
Webhooks ħerġin
Iffirmjati, jerġgħu jippruvaw b'backoff, u jitwasslu mill-inqas darba — għalhekk l-endpoint tiegħek għandu jkun idempotent ukoll. L-avvenimenti huma l-istess vokabolarju li jużaw ir-rapporti.
Tħassir u esportazzjoni
Kuntatt jista' jiġi esportat jew imħassar permezz tal-API, u t-tħassir jilħaq kull servizz aħwa li kellu kopja permezz tal-lane intern tal-familja nnifisha.
Kull ma l-interfaċċja tista' tagħmel, POST jista' jagħmel.
L-avvenimenti huma l-parti interessanti
Kull ħaġa oħra f'din il-paġna hija plumbing li tistenna. POST /v1/events hija r-rotta li tbiddel x'jintuża għalih il-prodott.
L-applikazzjoni tiegħek diġà taf ħwejjeġ li l-ebda għodda ta' marketing ma tista' tosserva: min lesta l-onboarding, min stieden kollega, min laqat limitu, min esporta d-data tiegħu nhar ta' Ħadd waranofsinhar. Ibgħathom bħala avvenimenti bit-token tiegħek stess, u kull wieħed isir trigger, kundizzjoni u segment.
Il-bqija jsegwi mill-mudell tal-kuntatt. L-avvenimenti jiżdiedu, qatt ma jinbidlu; huma l-log li l-prodott kollu jiddependi fuqu. Funnel li jattiva fuq avveniment li inti ddefinjt mhuwiex integrazzjoni — huwa l-istess mekkaniżmu li message_opened juża, b'isem differenti fih.
- 1Inti tibgħatu
POST /v1/events— isem, kuntatt, payload, ċavetta ta' idempotenza. - 2JasalJiżdied mal-log tal-kuntatt. Ħadd ieħor m'għandu bżonn jaf li jeżisti.
- 3Funnel jibdaKull funnel li d-dħul tiegħu jsemmi dak l-avveniment, għal kwalunkwe kuntatt eliġibbli taħt l-entry spec tiegħu.
- 4Funnels oħra jinfirdu fuqu"Jekk dan l-avveniment seħħ fl-aħħar 14 jum" huwa predikat ta' segment ordinarju.
- iU jtemm runsNode ta' għan li jsemmi l-istess avveniment jieqaf sekwenza l-istant li l-persuna tagħmel dik il-ħaġa.
Il-vokabolarju tiegħekIt-token tiegħek
Limiti li jixraqlu tkun tafhom qabel ma tibni
ClickSomo jaħżen tliet identifikaturi dwar inti — tenant, proġett u user, bħala ids opachi — u xejn ieħor. L-ebda password, l-ebda profil, l-ebda karta, l-ebda fattura. Il-limiti tal-pjan jaslu bħala numri: kemm kuntatti, kemm tibgħat, kemm ġenerazzjonijiet. Il-vokabolarju tal-ħlas ma jaqbiżx dak il-linja f'ebda direzzjoni.
Il-kuntatti tiegħek huma tiegħek. Inti d-data controller; aħna l-processor. M'hemm l-ebda rotta li biha prodott ieħor fil-familja jista' jaqra jew jikteb il-lista tal-kuntatti tiegħek, u l-ebda lane ta' ingest għalih juża.
Jekk qed tevalwah b'serjetà: aqra /docs qabel ma taqra iktar minn din is-sit. L-API hija d-deskrizzjoni onesta ta' x'jagħmel il-prodott, u kull pretensjoni f'dawn il-paġni timxi ma' rotta jew tip ta' node li tista' ssib hemm. Meta l-schema tinbidel, dawn il-paġni jinbidlu.