API
Nėra privataus galo taško. Netgi sąsajai.
Dauguma produktų turi du API: dokumentuotąjį, kuris Jums siūlomas, ir įdomųjį, kurį naudoja patys jų ekranai. Antrasis visada geresnis, ir prie jo Jums niekada neleidžiama priartėti. Čia yra vienas, o sąsaja yra jo klientas kaip ir bet kas kitas — tai mūsų apribojimas ir priežastis, kodėl viskas, ką norite sukurti, yra įmanoma.
Kuo ta taisyklė iš tikrųjų kainuoja
Tai reiškia, kad ekranas kartais turi laukti, kol API bus teisingas, o ne apeiti jį dėl vieno patogaus lauko. Diena, kai ekranui reikia ko nors, ko viešasis API negali duoti, yra diena, kai API yra neteisingas, ir sprendimas yra API.
Atlygis yra tas, kad trys labai skirtingi klientai beveik nieko nekainuoja papildomai. MCP serveris yra klientas. Dash-b plytelė yra klientas. Jūsų pati skriptas yra klientas. Nė vienas iš jų nėra antrarūšis pilietis, apeinantis paviršių, sukurtą kam nors kitam, nes nėra kito paviršiaus, kuriam būti antram.
Dokumentuotas ir išbandytas
OpenAPI generuojamas ties /docs, ir kiekvienas maršrutas turi testą, kuris yra pavyzdys dokumentacijoje. Dokumentacija, rašoma atskirai nuo kodo, per mėnesį atsilieka; dokumentacija, kuri klaidinga sugadina build'ą, — ne.
Prisijungimas
Jūsų castomo paskyra, per authorization code flow su PKCE — ta pati paskyra, kurią naudojate dash-b ir likusiai šeimai. Puslapis be savo serverio puikiai atlieka tą srautą; būtent tam jis sukurtas. Mašina–mašinai darbui — projekto apimties API raktas.
- 1Žmonės
/v1/contacts·/lists·/segments·/tags·/imports - 2Turinys
/v1/creatives, su patvirtinimu, peržiūra ir atvaizdavimu kiekvienam tikslui - 3Automatizavimas
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Transliacija
/v1/campaigns, su auditorija, materializavimu, planavimu ir siuntimu kaip atskirais žingsniais - 5Įvykiai į vidų
/v1/events— Jūsų pačios programos įvykiai kaip trigeriai - 6Pristatymas
/sender-identities·/domains·/apps·/webhooks - 7Skaičiai
/v1/reports/*, ir/track/*sekimo serveryje
OpenAPI ties /docs/mcp tame pačiame procese
Konvencijos
Ta pati forma kaip ir kiekvienoje kitoje castomo paslaugoje
Tai svarbiau, nei skamba. Jei jau kviečiate vieną iš šių, jau žinote, kaip šis atsako, nesėkmingai baigiasi ir puslapina.
Vienas klaidų vokas
Kiekvienas nesėkmingas atsakymas turi tą pačią formą, stabilius kodą ir žinutę, skirtą žmogui. Nė vienas maršrutas nesugalvoja savo būdo būti nelaimingam.
Žymeklio (cursor) puslapiavimas
Ne poslinkiai. Sąrašas, kuris keičiasi, kol juo einama, neslepia ir nekartoja eilučių, ką poslinkių puslapiavimas daro tyliai ir nuolat.
Idempotencijos raktai
Kiekvienam keičiančiam maršrutui. Pakartokite užklausą, kurios pristatymu nesate tikri, ir gaukite tą patį atsakymą, o ne antrą kontaktą, antrą kampaniją ar antrą siuntimą.
Apimta projekto
Žetonas nukreipia į vieną nuomininką ir vieną projektą, abu. Eilutės lygio saugumas įgyvendinamas pačioje duomenų bazėje, o ne prisiminus pridėti sąlygą.
Webhook'ai į išorę
Pasirašyta, bandyta iš naujo su atitraukimu ir pristatyta bent kartą — tad jūsų galutinis taškas taip pat turėtų būti idempotentinis. Įvykiai vartoja tą pačią terminiją, kurią naudoja ataskaitos.
Ištrynimas ir eksportas
Kontaktą galima eksportuoti arba ištrinti per API, o ištrynimas pasiekia kiekvieną giminingą tarnybą, laikiusią kopiją, per šeimos vidinį kanalą.
Viską, ką gali sąsaja, gali POST užklausa.
Įvykiai – įdomiausia dalis
Viskas kita šiame puslapyje – įprasta infrastruktūra, kurios ir tikėtumėte. POST /v1/events yra maršrutas, keičiantis produkto paskirtį.
Jūsų programa jau žino dalykų, kurių joks rinkodaros įrankis nemato: kas užbaigė įvadą, kas pakvietė kolegą, kas pasiekė ribą, kas eksportavo savo duomenis sekmadienio popietę. Paskelbkite juos kaip įvykius su savo raktu, ir kiekvienas taps trigeriu, sąlyga ir segmentu.
Visa kita išplaukia iš kontaktų modelio. Įvykiai tik pridedami, niekada neredaguojami; tai įrašas, ant kurio laikosi visas produktas. Piltuvas, suveikiantis nuo jūsų apibrėžto įvykio, nėra integracija – tai tas pats mechanizmas, kurį naudoja message_opened, tik kitu pavadinimu.
- 1Jūs jį paskelbiate
POST /v1/events– pavadinimas, kontaktas, duomenų rinkinys, idempotentiškumo raktas. - 2Jis įrašomasPridedamas prie kontakto įrašų. Kam nors kitam nereikia žinoti, kad jis egzistuoja.
- 3Prasideda piltuvasBet kuris piltuvas, kurio įėjime minimas tas įvykis, bet kuriam kontaktui, atitinkančiam jo įėjimo sąlygas.
- 4Kiti piltuvai šakoja nuo jo„Ar šis įvykis įvyko per pastarąsias 14 dienų“ – paprasta segmento sąlyga.
- iIr jis baigia vykdymusTikslų mazgas, minimas tą patį įvykį, sustabdo seką tą akimirką, kai asmuo tai padaro.
Jūsų terminijaJūsų raktas
Ribos, verta žinoti prieš pradedant kurti
ClickSomo saugo tris jūsų identifikatorius – nuomotoją, projektą ir vartotoją kaip neperšviečiamus id – ir nieko daugiau. Jokio slaptažodžio, jokio profilio, jokios kortelės, jokios sąskaitos. plano ribos atkeliauja kaip skaičiai: kiek kontaktų, kiek siuntimų, kiek generavimų. Mokėjimo terminija neperžengia tos linijos nėra viena kryptimi.
Jūsų kontaktai priklauso jums. Jūs esate duomenų valdytojas; mes esame tvarkytojas. Nėra jokio maršruto, kuriuo kitas šeimos produktas galėtų skaityti ar rašyti jūsų kontaktų sąrašą, ir nėra duomenų ėjimo kanalo, kurį jis galėtų naudoti.
Jei rimtai svarstote naudoti: prieš skaitydami daugiau šios svetainės, perskaitykite /docs. API yra sąžiningas produkto veikimo aprašymas, ir kiekvienas teiginys šiuose puslapiuose atitinka maršrutą arba mazgo tipą, ten randamą. Pasikeitus schemai, pasikeičia ir šie puslapiai.