API
Privāta galapunkta nav. Pat ne saskarnei.
Lielākajai daļai produktu ir divi API: dokumentētais, ko Jums piedāvā, un interesantais, ko izmanto pašu ekrāni. Otrs vienmēr ir labāks, un Jums tam nekad nav pieejas. Šeit ir tikai viens, un saskarne ir tā klients tāpat kā jebkas cits — tas ir ierobežojums mums un iemesls, kāpēc viss, ko Jūs vēlaties uzbūvēt, ir iespējams.
Ko šis noteikums patiesībā izmaksā
Tas nozīmē, ka ekrānam reizēm jāgaida, līdz API ir pareizs, nevis jāapiet tas ap apkārt viena ērta lauka dēļ. Diena, kad ekrānam vajag kaut ko, ko publiskais API nespēj dot, ir diena, kad API ir nepareizs, un risinājums ir API.
Ieguvums ir tas, ka trīs ļoti atšķirīgi klienti izmaksā gandrīz neko papildu. MCP serveris ir klients. dash-b flīze ir klients. Jūsu pašu skripts ir klients. Neviens no tiem nav otrās šķiras pilsonis, kas apiet kādas virsmas, kas paredzēta kādam citam, jo nav citas virsmas, kurai būt otrajam.
Dokumentēts un pārbaudīts
OpenAPI tiek ģenerēts /docs, un katrai maršrutam ir tests, kas ir piemērs dokumentācijā. Dokumentācija, kas rakstīta atsevišķi no koda, mēneša laikā atpaliek; dokumentācija, kas, būdama nepareiza, sagraūj būvi — nē.
Pieteikšanās
Jūsu castomo konts, izmantojot authorization code plūsmu ar PKCE — tas pats konts, ko lietojat dash-b un pārējai ģimenei. Lapa bez sava servera šo plūsmu veic lieliski; tieši tam tā tika izstrādāta. Mašīnas-saziņai-ar-mašīnu darbiem — projekta apjoma API atslēga.
- 1Cilvēki
/v1/contacts·/lists·/segments·/tags·/imports - 2Saturs
/v1/creatives, ar validāciju, priekšskatījumu un renderēšanu katram mērķim - 3Automatizācija
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Apraide
/v1/campaigns, ar auditoriju, materializēšanu, plānošanu un sūtīšanu kā atsevišķiem soļiem - 5Notikumi iekšā
/v1/events— Jūsu pašu lietotnes notikumi kā trigeri - 6Piegāde
/sender-identities·/domains·/apps·/webhooks - 7Skaitļi
/v1/reports/*un/track/*izsekošanas resursdatorā
OpenAPI /docs/mcp tajā pašā procesā
Konvencijas
Tā pati struktūra kā jebkuram citam castomo servisu
Un tas ir svarīgāk, nekā izklausās. Ja Jūs jau izsaucat vienu no šiem, Jūs jau zināt, kā šis atbild, neizdodas un sadala lapās.
Viens kļūdu aploksnis
Katrai neveiksmei ir tā pati struktūra, stabils kods un ziņojums, kas paredzēts cilvēkam. Neviens maršruts neizdomā savu veidu, kā būt neapmierinātam.
Kursora lapošana
Ne nobīdes. Saraksts, kas mainās, kamēr Jūs to iziet, netīšām neizlaiž un neatkārto rindas — ko nobīžu lapošana dara klusi un nepārtraukti.
Idempotences atslēgas
Uz katra mainoša maršruta. Atkārtojiet pieprasījumu, par kuru neesat pārliecināts, ka tas sasniedza mērķi, un saņemsiet to pašu atbildi, nevis otru kontaktu, otru kampaņu vai otru sūtījumu.
Attiecas uz projektu
Marķieris vienlaikus adresē vienu nomnieku un vienu projektu. Rindu līmeņa drošība tiek nodrošināta pašā datubāzē, nevis atkarībā no tā, vai atceraties pievienot nosacījumu.
Izejošie tīmekļa āķi
Parakstīti, atkārtoti ar pauzēm un piegādāti vismaz vienu reizi — tāpēc arī Jūsu galapunktam jābūt idempotentam. Notikumi izmanto to pašu vārdu krājumu, ko pārskati.
Dzēšana un eksports
Kontaktu var eksportēt vai izdzēst, izmantojot API, un dzēšana sasniedz katru blakus pakalpojumu, kurā ir kopija, caur pašas saimes iekšējo kanālu.
Viss, ko var saskarne, var izdarīt arī POST pieprasījums.
Notikumi ir interesantā daļa
Viss pārējais šajā lapā ir santehnika, kādu jūs gaidāt. POST /v1/events ir maršruts, kas maina to, kam produkts paredzēts.
Jūsu lietojumprogramma jau zina lietas, ko neviens mārketinga rīks neredz: kas pabeidza ievadapmācību, kas uzaicināja kolēģi, kas sasniedza ierobežojumu, kas svētdienas pēcpusdienā eksportēja savus datus. Nosūtiet tos kā notikumus ar savu marķieri, un katrs no tiem kļūst par trigeri, nosacījumu un segmentu.
Pārējais seko no kontakta modeļa. Notikumi tiek pievienoti, nekad laboti; tie ir žurnāls, uz kura balstās viss produkts. Piltuve, kas tiek izraisīta ar Jūsu definētu notikumu, nav integrācija — tā ir tā pati mehānismā, ko izmanto message_opened, tikai ar citu nosaukumu tajā.
- 1Jūs to nosūtāt
POST /v1/events— nosaukums, kontakts, krava un idempotences atslēga. - 2Tas ierodasTas tiek pievienots kontakta žurnālam. Nevienam citam nav jāzina, ka tas eksistē.
- 3Sākas piltuveJebkura piltuve, kuras ieeja min šo notikumu, jebkuram kontaktam, kas atbilst tās ieejas nosacījumiem.
- 4Citas piltuves uz to zarojas"Vai šis notikums noticis pēdējo 14 dienu laikā" ir parasts segmenta predikāts.
- iUn tas beidz izpildesMērķa mezgls, kas min to pašu notikumu, aptur secību brīdī, kad cilvēks izdara šo darbību.
Jūsu vārdu krājumsJūsu marķieris
Robežas, kas jāzina pirms būvēšanas
ClickSomo glabā par Jums trīs identifikatorus — nomnieku, projektu un lietotāju, kā necaurspīdīgus id — un neko vairāk. Ne paroli, ne profilu, ne karti, ne rēķinu. Plāna ierobežojumi nāk kā skaitļi: cik kontaktu, cik nosūtījumu, cik ģenerējumu. Maksājumu vārdu krājums nepārsniedz šo robežu nevienā virzienā.
Jūsu kontakti pieder Jums. Jūs esat datu pārzinis; mēs esam apstrādātājs. Nav neviena ceļa, pa kuru cits saimes produkts varētu lasīt vai rakstīt Jūsu kontaktu sarakstu, un nav neviena uzņemšanas kanāla, ko tas varētu izmantot.
Ja šo vērtējat nopietni: izlasiet /docs, pirms lasāt vēl ko šajā vietnē. API ir godīgs apraksts tam, ko produkts dara, un katrs apgalvojums šajās lapās atbilst maršrutam vai mezgla tipam, ko tur varat atrast. Kad shēma mainās, mainās arī šīs lapas.