clickSomo

API

Tiada titik akhir peribadi. Malah untuk antara muka sendiri.

Kebanyakan produk mempunyai dua API: yang didokumenkan dan ditawarkan kepada anda, dan yang menarik digunakan oleh skrin mereka sendiri. Yang kedua sentiasa lebih baik, dan anda tidak pernah dibenarkan menghampirinya. Di sini hanya ada satu, dan antara muka ialah pelanggan baginya seperti apa-apa sahaja yang lain — itu kekangan bagi kami, dan sebab segala yang anda mahu bina adalah mungkin.

Apa sebenarnya kos peraturan itu

Ia bermakna sesekali skrin terpaksa menunggu API menjadi betul, dan bukannya memintasnya untuk satu medan yang mudah. Hari apabila skrin memerlukan sesuatu yang API awam tidak dapat berikan itulah hari API itu salah, dan penyelesaiannya ialah API.

Ganjarannya ialah tiga pelanggan yang sangat berbeza hampir tidak menambah kos. Pelayan MCP ialah pelanggan. Tile dash-b ialah pelanggan. Skrip anda sendiri ialah pelanggan. Tiada satu pun ialah warga kelas kedua yang berpatah balik pada permukaan yang direka untuk orang lain, kerana tiada permukaan lain untuk dikalahkan.

Didokumenkan, dan diuji

OpenAPI dijana di /docs dan setiap laluan mempunyai ujian yang merupakan contoh dalam dokumentasi. Dokumentasi yang ditulis berasingan daripada kod akan terpesong dalam sebulan; dokumentasi yang gagalkan binaan apabila ia salah tidak.

Log masuk

Akaun castomo anda, melalui aliran kod kebenaran dengan PKCE — akaun yang sama anda gunakan untuk dash-b dan yang lain dalam keluarga ini. Halaman tanpa pelayannya sendiri boleh menjalankan aliran itu dengan sempurna; memang itulah tujuan aliran itu direka. Untuk kerja mesin-ke-mesin, kunci API berlingkup projek.

Permukaanapi.clicksomo.com
  • 1Orang/v1/contacts · /lists · /segments · /tags · /imports
  • 2Kandungan/v1/creatives, dengan pengesahan, pratonton dan pemaparan bagi setiap sasaran
  • 3Automasi/v1/funnels · /funnels/:id/versions · /runs · /simulate
  • 4Penyiaran/v1/campaigns, dengan khalayak, materialisasi, penjadualan dan penghantaran sebagai langkah berasingan
  • 5Peristiwa masuk/v1/events — peristiwa aplikasi anda sendiri, sebagai pencetus
  • 6Penghantaran/sender-identities · /domains · /apps · /webhooks
  • 7Nombor/v1/reports/*, dan /track/* pada hos penjejakan

OpenAPI di /docs/mcp pada proses yang sama

Konvensyen

Bentuk yang sama seperti setiap perkhidmatan castomo yang lain

Yang lebih penting daripada yang didengar. Jika anda sudah memanggil salah satu daripadanya, anda sudah tahu bagaimana yang ini menjawab, gagal dan menganak muka.

Satu sampul ralat

Setiap kegagalan mempunyai bentuk yang sama, kod yang stabil dan mesej yang ditujukan kepada manusia. Tiada laluan mencipta caranya sendiri untuk tidak berpuas hati.

Penghalaman kursor

Bukan offset. Senarai yang berubah semasa anda menelusurinya tidak secara senyap melangkau atau mengulangi baris, yang dilakukan oleh penghalaman offset secara senyap dan berterusan.

Kunci idempotensi

Pada setiap laluan yang mengubah. Cuba semula permintaan yang anda tidak pasti sampai dan dapat jawapan yang sama dan bukannya kenalan kedua, kempen kedua atau penghantaran kedua.

Terlingkup kepada satu projek

Token merujuk kepada satu penyewa dan satu projek, kedua-duanya sekali. Keselamatan tahap baris dikuatkuasakan dalam pangkalan data itu sendiri, bukan dengan mengingat untuk menambah klausa.

Webhook keluar

Ditandatangani, dicuba semula dengan backoff, dan dihantar sekurang-kurangnya sekali — jadi endpoint Anda juga perlu idempoten. Peristiwa menggunakan kosa kata yang sama seperti laporan.

Pemadaman dan eksport

Seseorang kenalan boleh dieksport atau dipadamkan melalui API, dan pemadaman sampai ke setiap perkhidmatan lain yang menyimpan salinannya melalui laluan dalaman keluarga itu sendiri.

Segala yang boleh dilakukan antara muka, boleh dilakukan dengan POST.

Peristiwa ialah bahagian yang menarik

Segala yang lain di halaman ini hanyalah perpaipan yang sudah Anda jangka. POST /v1/events ialah laluan yang mengubah tujuan produk ini.

Aplikasi Anda sudah mengetahui perkara yang tidak dapat diperhatikan oleh sebarang alat pemasaran: siapa yang menamatkan onboarding, siapa yang menjemput rakan sekerja, siapa yang mencapai had, siapa yang mengeksport data mereka pada petang Ahad. Hantar semuanya sebagai peristiwa dengan token Anda sendiri, dan setiap satu menjadi pencetus, syarat dan segmen.

Selebihnya berpunca daripada model kenalan. Peristiwa ditambah, tidak pernah disunting; ia ialah log yang menjadi tunjang seluruh produk. Corong yang tercetus oleh peristiwa yang Anda takrifkan bukanlah integrasi — ia adalah mekanisme yang sama seperti message_opened, hanya dengan nama berbeza di dalamnya.

Peristiwa Anda menjadi corongapi_event
  • 1Anda menghantarnyaPOST /v1/events — satu nama, satu kenalan, satu payload, satu kunci idempotensi.
  • 2Ia tibaDitambah ke log kenalan tersebut. Tiada apa-apa lagi perlu tahu ia wujud.
  • 3Corong bermulaSebarang corong yang kemasukannya menyebut peristiwa itu, untuk sebarang kenalan yang layak mengikut spesifikasi kemasukannya.
  • 4Corong lain bercabang ke atasnya"Adakah peristiwa ini berlaku dalam 14 hari terakhir" ialah predikat segmen biasa.
  • iDan ia menamatkan larianNod matlamat yang menyebut peristiwa yang sama menghentikan urutan pada saat orang itu melakukan perkara tersebut.

Kosa kata AndaToken Anda

Sempadan yang patut diketahui sebelum anda membina

ClickSomo menyimpan tiga pengecam tentang Anda — satu penyewa, satu projek dan satu pengguna, sebagai id legap — dan tiada apa-apa lagi. Tiada kata laluan, tiada profil, tiada kad, tiada invois. Had pelan tiba sebagai nombor: berapa banyak kenalan, berapa banyak penghantaran, berapa banyak penjanaan. Kosa kata pembayaran tidak melintasi garisan itu dari sebarang arah.

Kenalan Anda adalah milik Anda. Anda ialah pengawal data; kami ialah pemproses. Tiada laluan yang membolehkan produk lain dalam keluarga ini membaca atau menulis senarai kenalan Anda, dan tiada laluan penyerapan untuk digunakan.

Jika anda benar-benar menilai ini: baca /docs sebelum membaca mana-mana bahagian lain laman web ini. API ialah gambaran jujur tentang apa yang dilakukan produk ini, dan setiap dakwaan di halaman-halaman ini dipetakan kepada laluan atau jenis nod yang boleh anda temui di sana. Apabila skema berubah, halaman-halaman ini berubah.