API
Жеке (приватты) endpoint жоқ. Тіпті интерфейс үшін де жоқ.
Көптеген өнімдердің екі API-і бар: сізге ұсынылған құжатталғаны және олардың өз экрандары пайдаланатын қызықтысы. Екіншісі әрқашан жақсырақ, және сізге оған жақындауға ешқашан рұқсат берілмейді. Мұнда біреуі ғана бар, және интерфейс оның басқа да нәрселер сияқты клиенті — бұл бізге қойылған шектеу, және сіз құрастырғыңыз келетін нәрсенің бәрі мүмкін болатын себеп.
Бұл ереженің шынайы бағасы
Бұл кейде экранның бір ыңғайлы өрісті айналып өтіп алу орнына API-дің дұрыс жауабын күтуге тура келетінін білдіреді. Экранға жалпыға ортақ API бере алмайтын нәрсе қажет болған күн — API-дің дұрыс емес күні, және шешім — API-дің өзі.
Пайдасы — үш мүлде басқа клиент қосымша дерлік ештеңе тұрмайды. MCP сервері — клиент. dash-b плиткасы — клиент. Сіздің өз скриптіңіз — клиент. Олардың ешқайсысы басқа біреуге арналған бетті айналып өтетін екінші дәрежелі азамат емес, өйткені екінші орында қалатын басқа бет жоқ.
Құжатталған және тексерілген
OpenAPI /docs адресінде генерацияланады және әрбір маршруттың құжаттамадағы мысал болып табылатын тесті бар. Кодтан бөлек жазылған құжаттама бір айдың ішінде ауытқиды; дұрыс болмағанда құрылысты тоқтататын құжаттама — ауытқымайды.
Кіру
Сіздің castomo аккаунтыңыз, PKCE бар authorization code flow арқылы — dash-b және отбасының қалғаны үшін пайдаланатын сол аккаунт. Өз сервері жоқ бет ол ағынды тамаша орындайды; ағын дәл осыған арналған. Машина-машина жұмысы үшін — жобаға шектелген API кілті.
- 1Адамдар
/v1/contacts·/lists·/segments·/tags·/imports - 2Мазмұн
/v1/creatives, әр мақсат үшін валидация, алдын ала қарау және рендермен - 3Автоматтандыру
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Трансляция
/v1/campaigns, аудитория, материалдау, жоспарлау және жіберу бөлек қадамдар ретінде - 5Кіретін оқиғалар
/v1/events— сіздің өз қосымшаңыздың оқиғалары, триггерлер ретінде - 6Жеткізу
/sender-identities·/domains·/apps·/webhooks - 7Сандар
/v1/reports/*, және бақылау хостында/track/*
/docs адресінде OpenAPIСол процесс үстінде /mcp
Келісімдер
Басқа барлық castomo сервисімен бірдей пішін
Бұл үндеуге қарағанда маңыздырақ. Егер сіз олардың бірін әлдеқашан шақырып жүрсеңіз, бұл қалай жауап беретінін, қалай істен шығатынын және қалай беттеуін әлдеқашан білесіз.
Бір қате конверті
Әрбір істен шығудың бірдей пішіні, тұрақты коды және адамға арналған хабарламасы бар. Ешбір маршрут өзінің ренжудің жеке тәсілін ойлап таппайды.
Курсорлық беттеу
Офсеттер емес. Жүріп келе жатқанда өзгеріп отыратын тізім жолдарды үнсіз өткізіп жібермейді немесе қайталамайды, ал офсеттік беттеу мұны үнемі және үнсіз жасайды.
Идемпотенттік кілттер
Әрбір өзгертетін маршрутта. Жеткеніне күмәнданған сұранысты қайта жіберіңіз де, екінші контакт, екінші кампания немесе екінші жіберудің орнына сол жауапты алыңыз.
Жобаға шектелген
Токен бір tenant пен бір жобаны, екеуін де, адресатайды. Жол деңгейіндегі қауіпсіздік дерекқордың өзінде орындалады, шарт қосуды ұмытпау арқылы емес.
Шығатын вебхуктар
Қол қойылған, backoff арқылы қайта жіберілген және кемінде бір рет жеткізілген — сондықтан сіздің endpoint-іңіз де идемпотентті болуы керек. Оқиғалар есептер пайдаланатын сол сөздік.
Жою және экспорттау
Контактты API арқылы экспорттауға немесе жоюға болады, ал жою отбасының ішкі арнасы арқылы көшірмені сақтаған әрбір туыстас қызметке жетеді.
Интерфейстің істей алатынның бәрін POST та істей алады.
Оқиғалар — ең қызықты бөлігі
Осы беттегі қалған нәрсе — сіз күтетін құбыжық жұмыстар. POST /v1/events — өнімнің не үшін екенін өзгертетін маршрут.
Сіздің қосымшаңыз маркетингтік құрал байқай алмайтын нәрселерді біледі: кім onboarding-ті аяқтады, кім әріптесін шақырды, кім шекті бұзды, кім жексенбі күні деректерін экспорттады. Оларды өз токеніңізбен оқиға ретінде жіберіңіз, және әрқайсысы триггер, шарт және сегментке айналады.
Қалғаны контакт моделінен туындайды. Оқиғалар қосымша жазылады, ешқашан өңделмейді; олар бүкіл өнім сүйенетін журнал. Сіз анықтаған оқиғаға іске қосылатын воронка — интеграция емес; бұл message_opened қолданатын сол механизм, тек атауы басқа.
- 1Сіз оны жібереді
POST /v1/events— атау, контакт, payload, идемпотенттік кілт. - 2Ол жетедіКонтакттың журналына қосылады. Оның бар екенін ештеңе білудің қажеті жоқ.
- 3Воронка басталадыКіруі сол оқиғаны атайтын кез келген воронка, өзінің кіру шартына сай кез келген контакт үшін.
- 4Басқа воронкалар одан тармақталады"Бұл оқиға соңғы 14 күнде болды ма" — қарапайым сегмент шарты.
- iЖәне ол өткізілімдерді аяқтайдыСол оқиғаны атайтын мақсат түйіні адам сол әрекетті жасаған сәтте тізбекті тоқтатады.
Сіздің сөздігіңізСіздің токеніңіз
Құрылмас бұрын білуге тұратын шектер
ClickSomo сіз туралы үш идентификатор сақтайды — tenant, жоба және пайдаланушы, мөлдір емес id ретінде — және басқа ештеңе. Құпиясөз жоқ, профиль жоқ, карта жоқ, invoice жоқ. Жоспар шектері сандар түрінде келеді: қанша контакт, қанша жіберу, қанша генерация. Төлем лексикасы сол шекарадан екі бағытта да өтпейді.
Сіздің контакттеріңіз — сіздікі. Деректерді басқарушы — сіз; өңдеуші — біз. Отбасындағы басқа өнімнің сіздің контакт тізіміңізді оқуына немесе жазуына мүмкіндік беретін жол жоқ, және ол пайдалануға арналған ingest арнасы да жоқ.
Егер сіз мұны мұқият бағалап жатсаңыз: осы сайттың қалғанын оқымай тұрып /docs бетін оқыңыз. API — өнімнің не істейтінінің адал сипаттамасы, және осы беттердегі әрбір талап сол жерде таба алатын маршрутқа немесе түйін түріне сәйкес келеді. Схема өзгергенде, бұл беттер де өзгереді.