API
Özel bir uç nokta yoktur. Arayüz için bile yoktur.
Çoğu ürünün iki API'si vardır: size sunulan belgelenmiş olan ve kendi ekranlarının kullandığı ilginç olan. İkincisi her zaman daha iyidir ve size asla yakınına gidilmez. Burada bir tane vardır ve arayüz, her şey gibi onun bir istemcisidir — bu bizim için bir kısıtlama ve kurmak istediğiniz her şeyin mümkün olmasının nedenidir.
Bu kuralın gerçekte maliyeti
Yani bir ekran bazen API'nin doğru olması için beklemek zorundadır; tek bir uygun alan için API'nin etrafından dolaşamaz. Bir ekranın, genel API'nin veremeyeceği bir şeye ihtiyaç duyduğu gün, API'nin yanlış olduğu gündür ve çözüm API'dir.
Kazanç, üç çok farklı istemcinin neredeyse hiç ek maliyete sahip olmamasıdır. MCP sunucusu bir istemcidir. Bir dash-b kutucuğu bir istemcidir. Kendi betiğiniz bir istemcidir. Hiçbiri, başkası için tasarlanmış bir yüzeyin etrafından dolaşan ikinci sınıf bir vatandaş değildir; çünkü ikincil olunacak başka bir yüzey yoktur.
Belgelenmiş ve çalıştırılmış
OpenAPI, /docs altında üretilir ve her rotanın, belgelerdeki örneği olan bir testi vardır. Koddan ayrı yazılan belgeler bir ay içinde eskir; yanlış olduğunda derlemi kıran belgeler eskimez.
Oturum açma
Sizin castomo hesabınız, PKCE ile yetkilendirme kodu akışı üzerinden — dash-b ve ailenin geri kalanı için kullandığınız hesabın aynısı. Kendi sunucusu olmayan bir sayfa bu akışı gayet iyi çalıştırır; akış zaten bunun için tasarlanmıştır. Makineden makineye işler için proje kapsamlı bir API anahtarı.
- 1Kişiler
/v1/contacts·/lists·/segments·/tags·/imports - 2İçerik
/v1/creatives, hedef başına doğrulama, önizleme ve render ile - 3Otomasyon
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Yayın
/v1/campaigns, hedef kitle, gerçekleştirme, zamanlama ve gönderme ayrı adımlar olarak - 5Gelen olaylar
/v1/events— kendi uygulamanızın olayları, tetikleyici olarak - 6Teslimat
/sender-identities·/domains·/apps·/webhooks - 7Sayılar
/v1/reports/*ve takip ana makinesinde/track/*
/docs altında OpenAPIAynı süreçte /mcp
Kurallar
Diğer her castomo servisiyle aynı şekil
Kulağa geldiğinden daha önemlidir. Bunlardan birini zaten çağırıyorsanız, bunun nasıl yanıt verdiğini, nasıl başarısız olduğunu ve nasıl sayfaladığını zaten biliyorsunuzdur.
Tek hata zarfı
Her başarısızlık aynı şekle, kararlı bir koda ve bir kişiye yönelik bir mesaja sahiptir. Hiçbir rota mutsuz olmanın kendi yolunu icat etmez.
İmleç sayfalama
Ofsetler değil. Gezerken değişen bir liste, satırları sessizce atlamaz veya tekrarlamaz; ofset sayfalama bunu sürekli ve sessizce yapar.
İdempotency anahtarları
Her değiştiren rotada. Ulaştığından emin olmadığınız bir isteği yeniden deneyin ve ikinci bir kişi, ikinci bir kampanya veya ikinci bir gönderim yerine aynı yanıtı alın.
Bir projeye kapsamlı
Bir token hem bir kiracıyı hem bir projeyi adresler. Satır düzeyi güvenlik, bir cümle eklemeyi hatırlamakla değil, veritabanının kendisinde uygulanır.
Giden webhooks
İmzalanır, geri kademeli yeniden denenir ve en az bir kez teslim edilir — bu yüzden uç noktanız da idempotent olmalı. Olaylar, raporların kullandığı aynı sözcük dağarcığıdır.
Silme ve dışa aktarma
Bir iletişim kişisi API üzerinden dışa aktarılabilir veya silinebilir; bir silme işlemi, ailenin kendi iç kanalı üzerinden kopya tutan her kardeş servise ulaşır.
Arayüzün yapabildiği her şeyi bir POST da yapabilir.
Asıl ilginç olan olaylar
Bu sayfadaki geri kalan her şey, beklediğiniz sıhhat tesisatıdır. POST /v1/events, ürünün ne işe yaradığını değiştiren rotadır.
Uygulamanız, hiçbir pazarlama aracının gözlemleyemeyeceği şeyleri zaten biliyor: kim onboarding'i tamamladı, kim bir çalışma arkadaşı davet etti, kim bir limite takıldı, kim pazar günü öğleden sonra verilerini dışa aktardı. Bunları kendi token'ınızla olay olarak gönderin; her biri bir tetikleyici, bir koşul ve bir segment olur.
Gerisi iletişim kişisi modelinden gelir. Olaylar eklenir, asla düzenlenmez; tüm ürünün dayandığı günlük onlardır. Sizin tanımladığınız bir olaya tetiklenen bir huni bir entegrasyon değildir — message_opened'ın kullandığı mekanizmanın aynısıdır, içindeki adı farklıdır.
- 1Siz gönderirsiniz
POST /v1/events— bir ad, bir iletişim kişisi, bir payload, bir idempotency anahtarı. - 2Kayıt düşerİletişim kişisinin günlüğüne eklenir. Varlığını bilmesi gereken başka hiçbir şey yoktur.
- 3Bir huni başlarGirişi o olayı adıyla anan her huni, giriş koşulları altında uygun her iletişim kişisi için başlar.
- 4Diğer huniler ona göre dallanır"Bu olay son 14 gün içinde gerçekleşti mi" sıradan bir segment koşuludur.
- iVe çalıştırmaları bitirirAynı olayı adıyla anan bir hedef düğümü, kişi o şeyi yaptığı anda bir diziyi durdurur.
Sizin dağarcığınızToken'ınız
İnşa etmeden önce bilinmeye değer sınırlar
ClickSomo sizinle ilgili üç tanımlayıcı tutar — bir kiracı, bir proje ve bir kullanıcı, opak kimlikler olarak — ve başka hiçbir şey tutmaz. Parola yok, profil yok, kart yok, fatura yok. Plan limitleri sayı olarak gelir: kaç iletişim kişisi, kaç gönderim, kaç üretim. Ödeme sözcükleri bu çizgiyi iki yönde de geçmez.
İletişim kişileriniz size aittir. Veri sorumlusu sizsiniz; işleyen biziz. Ailedeki başka bir ürünün iletişim kişi listenizi okumasına veya yazmasına giden bir yol yoktur ve birinin kullanabileceği bir veri alma kanalı da yoktur.
Bunu ciddi biçimde değerlendiriyorsanız: bu web sitesinin geri kalanını okumadan önce /docs sayfasını okuyun. API, ürünün ne yaptığının dürüst tanımıdır ve bu sayfalardaki her iddia, orada bulabileceğiniz bir rota ya da düğüm türüne karşılık gelir. Şema değiştiğinde bu sayfalar da değişir.