API
Ne postoji privatna krajnja točka. Čak ni za sučelje.
Većina proizvoda ima dva API-ja: dokumentirani koji Vam nude, i zanimljivi koji njihovi vlastiti zasloni koriste. Drugi je uvijek bolji, i nikada Vam se ne dopušta pristup. Ovdje postoji samo jedan, a sučelje je njegov klijent kao i sve ostalo — što je ograničenje za nas, i razlog zašto je sve što želite izgraditi moguće.
Koliko to pravilo stvarno košta
Znači da zaslon ponekad mora čekati da API bude ispravan, umjesto da ga zaobiđe radi jednog zgodnog polja. Dan kada zaslon treba nešto što javni API ne može dati jest dan kada je API pogrešan, i rješenje je u API-ju.
Prednost je da tri vrlo različita klijenta gotovo ništa ne koštaju dodatno. MCP poslužitelj je klijent. Dash-b pločica je klijent. Vaša vlastita skripta je klijent. Nijedan od njih nije građanin drugog reda koji zaobilazi površinu dizajniranu za nekog drugog, jer nema druge površine kojoj bi bio drugi.
Dokumentirano i provjeravano
OpenAPI se generira na /docs i svaka ruta ima test koji je primjer iz dokumentacije. Dokumentacija pisana odvojeno od koda za mjesec dana zaostane; dokumentacija koja pokvari build kad je pogrešna ne zaostaje.
Prijava
Vaš castomo račun, putem authorization code toka s PKCE — isti račun koji koristite za dash-b i ostatak obitelji. Stranica bez vlastitog poslužitelja taj tok izvodi sasvim dobro; upravo za to je tok i dizajniran. Za stroj-stroj komunikaciju, API ključ opsega projekta.
- 1Ljudi
/v1/contacts·/lists·/segments·/tags·/imports - 2Sadržaj
/v1/creatives, s validacijom, pregledom i prikazom po cilju - 3Automatizacija
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Emitiranje
/v1/campaigns, s publikom, materijalizacijom, raspoređivanjem i slanjem kao zasebnim koracima - 5Događaji ulaze
/v1/events— događaji Vaše vlastite aplikacije, kao okidači - 6Isporuka
/sender-identities·/domains·/apps·/webhooks - 7Brojevi
/v1/reports/*i/track/*na hostu za praćenje
OpenAPI na /docs/mcp na istom procesu
Konvencije
Isti oblik kao i svaka druga castomo usluga
Što je važnije nego što zvuči. Ako već pozivate jednu od ovih usluga, već znate kako ova odgovara, ne uspijeva i paginira.
Jedna omotnica za pogreške
Svaki neuspjeh ima isti oblik, stabilan kod i poruku namijenjenu osobi. Nijedna ruta ne izmišlja vlastiti način nezadovoljstva.
Paginacija kursorima
Ne pomacima. Popis koji se mijenja dok ga prolazite ne preskače i ne ponavlja retke u tišini, što paginacija pomacima čini stalno i neprimjetno.
Ključevi idempotencije
Na svakoj ruti koja mijenja podatke. Ponovite zahtjev za koji niste sigurni da je stigao i dobijte isti odgovor umjesto drugog kontakta, druge kampanje ili drugog slanja.
Opseg na projekt
Token adresira jednog stanara i jedan projekt, oboje. Sigurnost na razini redova provodi sama baza podataka, a ne sjećanje da se doda klauzula.
Odlazni webhooks
Potpisani, ponovno pokušavani s odmakom i isporučeni barem jednom — pa vaša krajnja točka također treba biti idempotentna. Događaji koriste isti vokabular kao i izvješća.
Brisanje i izvoz
Kontakt se može izvesti ili izbrisati putem API-ja, a brisanje doseže svaku sestrinsku uslugu koja je držala kopiju, kroz vlastiti interni kanal obitelji.
Sve što sučelje može, može i POST.
Događaji su zanimljivi dio
Sve ostalo na ovoj stranici je instalacija kakvu biste očekivali. POST /v1/events je ruta koja mijenja svrhu proizvoda.
Vaša aplikacija već zna stvari koje nijedan marketinški alat ne može promatrati: tko je završio uvod, tko je pozvao kolegu, tko je pogodio ograničenje, tko je izvezao svoje podatke u nedjelju poslijepodne. Objavite ih kao događaje sa svojim tokenom, i svaki od njih postaje okidač, uvjet i segment.
Ostatak slijedi iz modela kontakta. Događaji se dodaju, nikada ne uređuju; to je dnevnik na kojem počiva cijeli proizvod. Lijevka koja se okida na događaj koji ste vi definirali nije integracija — to je isti mehanizam koji koristi message_opened, samo s drugim imenom u sebi.
- 1Vi ga objavite
POST /v1/events— ime, kontakt, sadržaj, ključ idempotencije. - 2StigneDodaje se u dnevnik kontakta. Ništa drugo ne treba znati da postoji.
- 3Lijevka krećeSvaka lijevka čiji ulaz navodi taj događaj, za svaki kontakt koji ispunjava uvjete njezine ulazne specifikacije.
- 4Druge lijevke se granaju na njemu"Je li se ovaj događaj dogodio u posljednjih 14 dana" je običan predikat segmenta.
- iI završava pokretanjaČvor cilja koji navodi isti događaj zaustavlja slijed u trenutku kada osoba učini tu stvar.
Vaš vokabularVaš token
Granice vrijedne poznavanja prije nego što počnete graditi
ClickSomo pohranjuje tri identifikatora o vama — stanara, projekt i korisnika, kao neprozorne id-jeve — i ništa više. Bez lozinke, bez profila, bez kartice, bez računa. Ograničenja plana stižu kao brojevi: koliko kontakata, koliko slanja, koliko generiranja. Vokabular plaćanja ne prelazi tu granicu ni u jednom smjeru.
Vaši kontakti su vaši. Vi ste voditelj podataka; mi smo obrađivač. Ne postoji put kojim bi drugi proizvod u obitelji mogao čitati ili pisati vaš popis kontakata, niti kanal za unos koji bi jedan od njih mogao koristiti.
Ako ovo ozbiljno procjenjujete: pročitajte /docs prije nego što pročitate bilo što više s ovog web-mjesta. API je iskren opis onoga što proizvod radi, i svaka tvrdnja na ovim stranicama preslikava se na rutu ili vrstu čvora koju tamo možete pronaći. Kada se shema promijeni, ove se stranice mijenjaju.