Az API
Nincs privát végpont. Még csak a felület számára sem.
A legtöbb terméknek két API-ja van: a dokumentált, amelyet Önnek felajánlanak, és az érdekes, amelyet a saját képernyőik használnak. A második mindig jobb, és Ön soha nem férhet hozzá. Itt csak egy van, és a felület ugyanúgy a kliense, mint bármi más — ami számunkra korlát, és az oka annak, hogy minden, amit Ön építeni szeretne, megvalósítható.
Amit ez a szabály valójában megkövetel
Azt jelenti, hogy egy képernyőnek időnként meg kell várnia, míg az API helyes lesz, ahelyett, hogy egy kényelmes mezőért megkerülné. A nap, amikor egy képernyő olyat igényel, amit a nyilvános API nem tud adni, az a nap, amikor az API hibás — és a javítás az API.
A haszna pedig az, hogy három nagyon különböző kliens szinte semmilyen pluszköltséget nem jelent. Az MCP-kiszolgáló kliens. Egy dash-b csempe kliens. Az Ön saját szkriptje kliens. Egyik sem másodrendű állampolgár, amely egy másoknak tervezett felületet kerülget, mert nincs másik felület, amely mögött másodrendű lehetne.
Dokumentált és gyakorolt
Az OpenAPI a /docs útvonalon generálódik, és minden útvonalhoz tartozik egy teszt, amely a dokumentációban szereplő példa. A kódtól külön írt dokumentáció egy hónapon belül elavul; az a dokumentáció, amely hibásan megbuktatja a buildet, nem.
Bejelentkezés
Az Ön castomo fiókja, az engedélyezési kód folyamat keretében PKCE-vel — ugyanaz a fiók, amelyet a dash-b és a család többi tagja számára használ. Egy saját kiszolgáló nélküli oldal ezt a folyamatot tökéletesen lefuttatja; erre a célra tervezték. Gépről gépre történő munkához projekt-hatókörű API-kulcs.
- 1Emberek
/v1/contacts·/lists·/segments·/tags·/imports - 2Tartalom
/v1/creatives, validációval, előnézettel és megjelenítéssel célonként - 3Automatizálás
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Közvetítés
/v1/campaigns, közönséggel, anyagossá tétellel, ütemezéssel és küldéssel külön lépésként - 5Bejövő események
/v1/events— az Ön saját alkalmazásának eseményei, triggerként - 6Kézbesítés
/sender-identities·/domains·/apps·/webhooks - 7Számok
/v1/reports/*, valamint/track/*a követő gazdagépen
OpenAPI a /docs útvonalon/mcp ugyanazon a folyamaton
Konvenciók
Ugyanaz a forma, mint minden más castomo szolgáltatásé
Amely fontosabb, mint amilyennek hangzik. Ha már hívja ezen szolgáltatások egyikét, már tudja, hogyan válaszol, hibázik és lapoz ez is.
Egyetlen hibaburkolat
Minden hibának ugyanaz a formája, stabil kódja és embernek szánt üzenete. Egyetlen útvonal sem találja ki a saját módját a rosszkedv kifejezésére.
Kurzoros lapozás
Nem offszetek. Egy lista, amely változik, miközben Ön bejárja, nem hagy csendben kihagy vagy megismétel sorokat — az offszetes lapozás ezt csendben és folyamatosan teszi.
Idempotencia-kulcsok
Minden módosító útvonalon. Próbálja újra egy olyan kérést, amelyről nem biztos, hogy megérkezett, és ugyanazt a választ kapja, nem pedig egy második kapcsolatot, egy második kampányt vagy egy második küldést.
Projekthez kötve
Egy token egy bérlőt és egy projektet címez, mindkettőt. A sorszintű biztonságot maga az adatbázis kényszeríti ki, nem pedig egy záradék hozzáadására való emlékezés.
Kimenő webhookok
Aláírva, újrapróbálva exponenciális visszatartással, és legalább egyszer kézbesítve — így a végpontjának is idempotensnek kell lennie. Az események ugyanaz a szókincs, amelyet a jelentések használnak.
Törlés és exportálás
Egy kapcsolat exportálható vagy törölhető az API-n keresztül, és a törlés eljut minden testvérszolgáltatáshoz, amely másolatot tárolt, a család saját belső csatornáján.
Mindent, amit a felület tud, egy POST is tud.
Az események a legérdekesebb rész
Minden más ezen az oldalon olyan infrastruktúra, amire számít. A POST /v1/events az a végpont, amely megváltoztatja, mire való a termék.
Az Ön alkalmazása olyan dolgokat tud, amelyeket egyetlen marketingeszköz sem észlelhet: ki fejezte be a bevezetést, ki hívott meg egy kollégát, ki ütközött egy korlátba, ki exportálta az adatait egy vasárnap délután. Küldje el ezeket eseményként a saját tokenjével, és mindegyik kiváltó okká, feltétellé és szegmenné válik.
A többi a kapcsolatmodellből következik. Az események hozzáfűzésre kerülnek, soha nem szerkesztődnek; ez az a napló, amelyre az egész termék épül. Az Ön által definiált eseményre kiváltó tölcsér nem integráció — ugyanaz a mechanizmus, amelyet a message_opened használ, csak más névvel benne.
- 1Ön elküldi
POST /v1/events— egy név, egy kapcsolat, egy hasznos teher, egy idempotencia-kulcs. - 2MegérkezikHozzáfűzésre kerül a kapcsolat naplójához. Senkinek sem kell tudnia, hogy létezik.
- 3Egy tölcsér indulBármely tölcsér, amelynek belépési pontja említi az eseményt, a belépési specifikációja szerint jogosult kapcsolatok esetén.
- 4Más tölcsérek elágaznak rajtaA „történt-e ez az esemény az elmúlt 14 napban” egy közönséges szegmenspredikátum.
- ésÉs leállítja a futásokatUgyanazt az eseményt megnevező célcsomópont azonnal leállít egy szekvenciát, amint a személy elvégzi a dolgot.
Az Ön szókincseAz Ön tokenje
Határok, amelyeket érdemes ismerni, mielőtt épít
A ClickSomo három azonosítót tárol Önről — egy bérlőt, egy projektet és egy felhasználót, átlátszatlan azonosítókként —, és semmi mást. Nincs jelszó, nincs profil, nincs kártya, nincs számla. A csomagkorlátok számokként érkeznek: hány kapcsolat, hány küldés, hány generálás. A fizetési szókincs egyik irányban sem lépi át ezt a határt.
Az Ön kapcsolatai az Öné. Ön az adatkezelő; mi az adatfeldolgozó. Nincs olyan útvonal, amelyen a család másik terméke olvashatná vagy írhatná az Ön kapcsolatlistáját, és nincs betöltési csatorna sem, amelyet használhatna.
Ha komolyan értékeli ezt: olvassa el a /docs oldalt, mielőtt tovább olvasná ezt a weboldalt. Az API a termék tevékenységének őszinte leírása, és e lapok minden állítása egy ott megtalálható végpontra vagy csomóponttípusra vezethető vissza. Amikor a séma változik, ezek a lapok is változnak.