API
Özəl (private) endpoint yoxdur. İnterfeys üçün belə.
Əksər məhsulların iki API-si var: sizə təklif olunan sənədləşdirilmiş API və onların öz ekranlarının istifadə etdiyi maraqlı API. İkincisi həmişə daha yaxşıdır və sizə ona yaxınlaşmaq heç vaxt qadağandır. Burada biri var və interfeys onun başqa hər kəs kimi müştərisidir — bu, bizim üçün bir məhdudiyyət və sizin qurmaq istədiyiniz hər şeyin mümkün olmasının səbəbidir.
Bu qayda əslində nəyə başa gəlir
Bu o deməkdir ki, ekran bəzən API-nin düzgün olmasını gözləməli olur, bir rahat sahə üçün onu dolaşa bilməz. Ekranın public API-nin verə bilmədiyi bir şeyə ehtiyacı olduğu gün, API-nin səhv olduğu gündür və həll API-nin özüdür.
Qazanc odur ki, üç çox fərqli müştəri demək olar ki, heç bir əlavə xərcə başa gəlmir. MCP serveri bir müştəridir. Dash-b tiili bir müştəridir. Sizin öz skriptiniz bir müştəridir. Onların heç biri başqası üçün hazırlanmış səthi dolaşan ikinci dərəcəli vətəndaş deyil, çünki ikinci dərəcəli qala biləcəyi başqa səth yoxdur.
Sənədləşdirilib və yoxlanılıb
OpenAPI /docs ünvanında yaradılır və hər marşrutun sınağı sənədlərdəki nümunənin özüdür. Koddan ayrı yazılan sənədlər bir ay ərzində köhnəlir; səhv olduqda qurulmanı (build) dayandıran sənədlər isə köhnəlmir.
Giriş (Sign in)
Sizin castomo hesabınız, PKCE ilə authorization code axını üzərindən — dash-b və ailənin qalanı üçün istifadə etdiyiniz hesabın özü. Öz serveri olmayan bir səhifə bu axını mükəmməl icra edir; bu axın məhz bunun üçün hazırlanıb. Maşın-maşına işlər üçün layihə-əhatəli API açarı.
- 1İnsanlar
/v1/contacts·/lists·/segments·/tags·/imports - 2Məzmun
/v1/creatives, hər hədəf üçün validasiya, önizləmə və render ilə - 3Avtomatlaşdırma
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Yayım
/v1/campaigns, auditoriya, materializasiya, planlaşdırma və göndərmə ayrı-ayrı addımlar kimi - 5Gələn hadisələr
/v1/events— sizin öz tətbiqinizin hadisələri, tetikləyici (trigger) kimi - 6Çatdırılma
/sender-identities·/domains·/apps·/webhooks - 7Rəqəmlər
/v1/reports/*və izləmə hostunda/track/*
/docs ünvanında OpenAPIEyni prosesdə /mcp
Qaydalar
Digər hər castomo xidməti ilə eyni forma
Bu, səsləndiyindən daha vacibdir. Onlardan birini artıq çağırırsınızsa, bunun necə cavab verdiyini, necə xəta verdiyini və necə səhifələşdiyini artıq bilirsiniz.
Bir xəta zərfi
Hər xətanın eyni forması, sabit kodu və insan üçün nəzərdə tutulan mesajı var. Heç bir marşrut öz narazılıq ifadə üsulunu icad etmir.
Kursor səhifələməsi
Ofsetlər deyil. Gəzdiyiniz zaman dəyişən siyahı sətir-ləri səssizcə ötürmür və ya təkrarlamır — ofset səhifələməsi bunu səssizcə və daim edir.
İdentifikasiya (idempotency) açarları
Hər dəyişdirici (mutating) marşrutda. Çatmadığından əmin olmadığınız sorğunu təkrarlayın və ikinci əlaqə, ikinci kampaniya və ya ikinci göndərmə yerinə eyni cavabı alın.
Layihəyə bağlı
Token həm bir tenantı, həm də bir layihəni ünvanlayır. Sətir səviyyəli təhlükəsizlik verilənlər bazasının özündə tətbiq olunur, şərt əlavə etməyi xatırlamağa deyil.
Çıxan vebhuklar
İmzalanmış, geri addımlamalı (backoff) təkrarlanmış və ən azı bir dəfə çatdırılmış — beləliklə, sizin endpointiniz də idempotent olmalıdır. Hadisələr hesabatların istifadə etdiyi eyni lüğətdir.
Silinmə və ixrac
Kontakt API vasitəsilə ixrac və ya silinə bilər, silinmə isə ailənin öz daxili kanalı vasitəsilə surəti saxlayan hər qardaş xidmətə çatır.
İnterfeysin edə bildiyi hər şeyi POST da edə bilər.
Hadisələr maraqlı hissədir
Bu səhifədəki qalan hər şey gözlədiyiniz texniki infrastrukturdur. POST /v1/events məhsulun nə üçün olduğunu dəyişən marşrutdur.
Tətbiqiniz artıq heç bir marketinq alətinin müşahidə edə bilməyəcəyi şeyləri bilir: kim onboarding-i bitirib, kim həmkarını dəvət edib, kim limitə çatıb, kim bazar günü axşam məlumatlarını ixrac edib. Bunları öz tokeninizlə hadisə kimi göndərin və hər biri tetikleyici, şərt və seqmentə çevrilir.
Qalanı kontakt modelindən yaranır. Hadisələr əlavə olunur, heç vaxt redaktə olunmur; onlar bütün məhsulun asıldığı jurnaldır. Sizin təyin etdiyiniz hadisəyə başlayan funqel inteqrasiya deyil — bu, message_opened-ın istifadə etdiyi eyni mexanizmdir, yalnız içindəki adı fərqlidir.
- 1Siz onu göndərirsiniz
POST /v1/events— bir ad, bir kontakt, bir payload, bir idempotency açarı. - 2O çatırKontaktın jurnalına əlavə olunur. Onun mövcudluğunu bilməyə başqa heç nə ehtiyac duymur.
- 3Funnel başlayırGirişi həmin hadisəni adlandıran hər hansı funnel, giriş şərtlərinə uyğun gələn hər kontakt üçün.
- 4Digər funneller ona budaqlanır"Bu hadisə son 14 gün ərzində baş veribmi" — adi seqment şərtidir.
- iVə o, icraları bitirirEyni hadisəni adlandıran məqsəd düyünü şəxs o işi gördüyü anda ardıcıllığı dayandırır.
Sizin lüğətinizSizin tokeniniz
Qurmadan əvvəl bilməyə dəyər sərhədlər
ClickSomo sizin haqqınızda üç identifikator saxlayır — tenant, layihə və istifadəçi, qeyri-müəyyən id-lər kimi — və başqa heç nə. Parol yoxdur, profil yoxdur, kart yoxdur, faktura yoxdur. Plan limitləri rəqəm kimi gəlir: neçə kontakt, neçə göndəriş, neçə generasiya. Ödəniş lüğəti hər iki istiqamətdə bu xətti keçmir.
Kontaktlarınız sizindir. Məlumat idarəçisi sizsiniz; biz işləyən tərəfik. Ailədəki başqa bir məhsulun kontakt siyahınızı oxumasına və ya yazmasına gedən heç bir yol yoxdur, və onun istifadə edə biləcəyi ingest kanalı da yoxdur.
Bunu ciddi qiymətləndirirsinizsə: bu veb-saytın qalan hissəsini oxumazdan əvvəl /docs-u oxuyun. API məhsulun nə etdiyinin səmimi təsviridir və bu səhifələrdəki hər iddia orada tapa biləcəyiniz bir marşruta və ya düyün növünə uyğundur. Sxem dəyişdikdə, bu səhifələr dəyişir.