API

Ora ana endpoint pribadi. Malah kanggo antarmuka dhéwé ora ana.

Akeh produk duwe rong API: sing didokumentasikaké lan diwenehaké marang kowe, lan sing menarik sing dienggo layaré dhéwé. Sing kapindho mesthi luwih apik, lan kowe ora tau diidinake nyedhaki. Ing kene mung siji, lan antarmuka iku kliené kaya liyané — iku watesan kanggo dhéwé, lan alesané kabeh sing kokarepna gawé bisa kalakoni.

Apa sing bener dibayaraké aturan iku

Tegesé kadhangkala layar kudu ngenteni API bener dhisik, ora bisa nyambur sacedhake kanggo njupuk siji kolom sing gampang. Dina layar butuh barang sing API publik ora bisa menehi, dina iku API iku klentu, lan pangrèpé yaiku API-né.

Untunge, telung klien sing beda-beda banget mèh ora butuh biaya tambahan. Server MCP iku klien. Tile dash-b iku klien. Skripmu dhéwé iku klien. Ora siji wae sing kelas loro sing kudu ngakali permukaan sing digawé kanggo wong liya, amarga ora ana permukaan liya sing bisa dadi nomer siji.

Didokumentasikaké, lan dicek

OpenAPI digawé ing /docs lan saben rute duwe tes sing yaiku conto ing dokumentasi. Dokumentasi sing ditulis kapisah saka kode bakal geser ing sasi; dokumentasi sing gagal ing build nalika klentu ora bakal.

Mlebu log

Akun castomo-mu, liwat alur kode otorisasi karo PKCE — akun sing padha karo sing kokenggo kanggo dash-b lan liyané ing kulawarga. Kaca tanpa serveré dhéwé bisa mbukak alur iku kanthi apik; iku memang gunané alur kasebut. Kanggo pakaryan mesin-karo-mesin, kunci API winates proyek.

Permukaanéapi.clicksomo.com

1Wong/v1/contacts · /lists · /segments · /tags · /imports
2Isi/v1/creatives, kanthi validasi, pratinjau lan render saben target
3Otomatisasi/v1/funnels · /funnels/:id/versions · /runs · /simulate
4Siaran/v1/campaigns, kanthi audiens, materialise, jadwal lan kirim minangka langkah kapisah
5Acara mlebu/v1/events — acara saka aplikasimu dhéwé, minangka pemicu
6Pangiriman/sender-identities · /domains · /apps · /webhooks
7Angka/v1/reports/*, lan /track/* ing host pelacakan

OpenAPI ing /docs/mcp ing prosès sing padha

Konvensi

Wangun sing padha karo saben layanan castomo liyané

Iku luwih penting tinimbang katoné. Yen kowe wis tau nelpon siji saka iki, kowe wis ngerti carané iki menehi wangsulan, gagal lan kaca-kaca.

Siji amplop kesalahan

Sabeh kegagalan duwe wangun sing padha, kode sing stabil lan pesen sing ditujokaké marang wong. Ora ana rute sing nggawé cara dhéwé kanggo ngetokaké rasa ora seneng.

Pagination kursor

Ora offset. Dhaptar sing owah nalika koklewati ora bakel diam-diam nglirwakaké utawa mbalèni baris, sing offset pagination lakoni kanthi senyap lan terus-terusan.

Kunci idempotensi

Ing saben rute sing ngowahi. Balèni panjaluk sing ora yakin wis tekan lan entuk wangsulan sing padha, ora kontak kapindho, kampanye kapindho utawa kiriman kapindho.

Diwatesi mung ing sawijining proyek

Token nglayani siji tenant lan siji proyek, loro-lorone. Keamanan tingkat baris dienaké ing basis data dhéwé, ora kanthi kudu elinga nambah klausa.

Webhook metu

Ditandatangani, diulang kanthi backoff, lan dikirim paling sapisan — mulane endpoint sampeyan uga kudu idempoten. Acara-acara kasebut nganggo kosakata sing padha karo laporan.

Pambusakan lan ekspor

Kontak bisa diekspor utawa dibusak liwat API, lan pambusakan tekan saben layang sadulur sing nyimpen salinan liwat jalur internal kulawarga dhéwé.

Saben apa sing bisa ditindakaké antarmuka, bisa ditindakaké kanthi POST.

Acara iku bagéan sing menarik

Saben liyané ing kaca iki mung instalasi pipa sing wis sampeyan ngarep-arep. POST /v1/events iku rute sing ngowahi guna produk iki.

Aplikasi sampeyan wis ngerti bab-bab sing ora bisa diamati alat pemasaran: sapa sing rampung onboarding, sapa sing ngajak kolega, sapa sing kena watesan, sapa sing ngekspor data ing sore Minggu. Kirimna iku minangka acara nganggo token sampeyan dhéwé, lan saben siji dadi pemicu, syarat, lan segmen.

Sisane tindak saka model kontak. Acara ditambahake, ora tau diowahi; iku log sing kabeh produk nggantung ing kono. Funnel sing micu ing acara sing sampeyan dhéwé nemtokake dudu integrasi — iku mekanisme sing padha karo message_opened, mung jenengé beda.

Acara sampeyan dadi funnelapi_event

1Sampeyan ngirimPOST /v1/events — siji jeneng, siji kontak, siji payload, siji kunci idempotensi.
2Iku tekanDitambahake menyang log kontak. Ora ana liyané sing kudu ngerti iku ana.
3Funnel miwitiSaben funnel sing pérangan mlebu nyebut acara kasebut, kanggo saben kontak sing layak miturut spesifikasi mlebu.
4Funnel liya nyabang ing kono"Apa acara iki kadadéan ing 14 dina pungkasan" iku predikat segmen biyasa.
iLan iku mungkasi eksekusiSimpul tujuan sing nyebut acara sing padha mungkasi urutan ing wektu wong nindakake bab kasebut.

Kosakata sampeyanToken sampeyan

Watesan sing worth dingerteni sadurunge sampeyan mbangun

ClickSomo nyimpen telung pengenal babagan sampeyan — siji tenant, siji proyek lan siji panganggo, minangka id opaque — lan ora ana liyané. Ora ana sandhi, ora ana profil, ora ana kartu, ora ana faktur. Watesan paket teka minangka angka: pira kontak, pira kirim, pira generasi. Kosakata pembayaran ora nglampahi garis kasebut ing arah apa waé.

Kontak sampeyan iku duwé sampeyan. Sampeyan pangendhali data; kita pangolahan. Ora ana rute sing bisa ngidini produk liya ing kulawarga maca utawa nulis dhaptar kontak sampeyan, lan ora ana jalur ingest kanggo digunakake.

Yen sampeyan nyeriusi ngevaluasi iki: maca /docs sadurunge maca liya ing situs iki. API iku gambaran jujur babagan apa sing ditindakake produk, lan saben klaim ing kaca-kaca iki map menyang rute utawa jinis simpul sing bisa sampeyan temokake ing kono. Nalika skema owah, kaca-kaca iki owah.