clickSomo

API-ið

Það er ekkert einkaaðgangsmark. Ekki einu sinni fyrir viðmótið.

Flestir eiga tvenn API: það skjalaða sem þér er boðið, og það áhugaverða sem eigin skjáir þeirra nota. Hið síðarnefnda er alltaf betra, og þér er aldrei leyft nálægt því. Hér er aðeins eitt, og viðmótið er biðlari þess eins og allt annað — sem er takmörkun fyrir okkur, og ástæðan fyrir því að allt sem þú vilt byggja er mögulegt.

Hvað þessi regla kostar í raun

Það þýðir að skjár þarf stundum að bíða eftir að API-ið sé rétt, í stað þess að fara framhjá því fyrir eitt þægilegt svið. Þann dag sem skjár þarfnast eitthvað sem opinbera API-ið getur ekki gefið er þann dag API-ið rangt, og lausnin er API-ið.

Arðurinn er að þrír mjög ólíkir biðlarar kosta næstum ekkert aukalega. MCP-þjónninn er biðlari. Dash-b flísa er biðlari. Eigin handritið þitt er biðlari. Ekkert þeirra er annars flokks borgari sem fer framhjá yfirborði hannað fyrir einhvern annan, því það er ekkert annað yfirborð til að vera annars flokks við.

Skjalað og notað

OpenAPI er búið til á /docs og hver leið hefur próf sem er dæmið í skjöluninni. Skjölun sem er skrifuð aðskilin frá kóðanum sveigist innan mánaðar; skjölun sem brýtur buildið þegar hún er röng gerir það ekki.

Innskráning

Castomo-aðgangurinn þinn, gegnum authorization code flæðið með PKCE — sama aðganginn og þú notar fyrir dash-b og restina af fjölskyldunni. Síða án eigin netþjóns keyrir það flæði fullkomlega; það er fyrir það sem flæðið var hannað. Fyrir vél-til-véls vinnu, API-lykill takmarkaður við verkefni.

Yfirborðiðapi.clicksomo.com
  • 1Fólk/v1/contacts · /lists · /segments · /tags · /imports
  • 2Efni/v1/creatives, með staðfestingu, forskoðun og myndgerð fyrir hvert mark
  • 3Sjálfvirkni/v1/funnels · /funnels/:id/versions · /runs · /simulate
  • 4Útsending/v1/campaigns, með áhorfendum, efnisgerð, áætlun og sendingu sem aðskilin skref
  • 5Atburðir inn/v1/events — atburðir eigin forritsins þíns, sem kveikjur
  • 6Afhending/sender-identities · /domains · /apps · /webhooks
  • 7Tölur/v1/reports/*, og /track/* á rakningarvélinni

OpenAPI á /docs/mcp á sama ferli

Venjur

Sama form og allar aðrar castomo-þjónustur

Sem skiptir meira máli en það hljómar. Ef þú kallar þegar í eitt af þessum veistu þegar hvernig þetta svarar, bregst við villum og síðubýr.

Eitt villuumslag

Hver bilun hefur sama formið, stöðugan kóða og skilaboð ætluð manni. Engin leið finnur upp sinn eigin hátt að vera óánægð.

Síðubýningur með bendlum

Ekki hliðrun. Listi sem breytist á meðan þú gengur um hann sleppur ekðjúgt eða endurtekur raðir, sem hliðrunarsíðubýningur gerir hljótt og stöðugt.

Idempotency-lyklar

Á hverri breytandi leið. Endurtaktu beiðni sem þú ert ekki viss um að hafi komist og fáðu sama svarið í stað annars tengiliðar, annarrar herferðar eða annarrar sendingar.

Takmarkað við verkefni

Token er bindur bæði við eitt leigjandasvæði og eitt verkefni. Róarstig öryggi er framfylgt í gagnagrunninum sjálfum, ekki með því að muna að bæta við skilyrði.

Webhooks út

Undirritað, endursent með bið og afhent a.m.k. einu sinni — svo endapunktur þinn ætti einnig að vera idempotent. Atburðirnir nota sama orðaforota og skýrslurnar.

Eyðing og útflutningur

Hægt er að flytja út eða eyða tengilið um API, og eyðing nær til allra systkerþjónusta sem geyma afrit, gegnum eigin innri rás fjölskyldunnar.

Allt sem viðmótið getur gert, getur POST gert.

Atburðir eru það áhugaverða

Allt annað á þessari síðu er pípulagning sem þú væntir þér. POST /v1/events er leiðin sem breytir því hvað varan er fyrir.

Forritið þitt veit þegar hluti sem enginn markaðstól getur séð: hver lauk innleiðingu, hver bauð kollega, hver rakst á takmörk, hver flutti út gögn sín á sunnudegi seint á dag. Sendu þau sem atburði með eigin token þínum, og hver þeirra verður kveikja, skilyrði og hluti.

Restin fylgir tengiliðalíkaninu. Atburðir eru bætt við, aldrei breytt; þeir eru logginn sem allt varan hangir á. Trekt sem kveikir á atburði sem þú skilgreindir er ekki samþætting — það er sama kerfi og message_opened notar, með öðru nafni í.

Atburður þinn verður trektapi_event
  • 1Þú sendir hann innPOST /v1/events — nafn, tengiliður, álag og idempotency-lykill.
  • 2Hann berstBætt við logg tengiliðsins. Ekkert annar þarf að vita að hann er til.
  • 3Trekt hefstHver trekt sem inngangurinn nefnir þann atburði, fyrir hvern tengilið sem uppfyllir inngangsskilyrðin.
  • 4Aðrar trektir greina eftir honum"Hefur þessi atburður gerst síðustu 14 daga" er venjulegt hlutaskilyrði.
  • iOg hann lýkur keyrslumMarkmiðshnútur sem nefnir sama atburð stöðvar röð í því augnabliki sem manneskjan gerir hlutinn.

Orðaforotinn þinnTokeninn þinn

Mörk sem vert er að þekkja áður en þú byggir

ClickSomo geymir þrjú auðkenni um þig — leigjandasvæði, verkefni og notanda, sem ógagnsæ auðkenni — og ekkert annað. Ekkert lykilorð, ekkert sniðmát, ekkert kort, enginn reikningur. Takmörk áætlunar berast sem tölur: hversu margir tengiliðir, hversu margar sendingar, hversu margar kynslóðir. Greiðsluorðaforoti fer ekki yfir þá línu í neina átt.

Tengiliðirnir þínir eru þínir. Þú ert gagnastjórnandi; við erum úrvinnsluaðili. Engin leið er til þess að annar vöru í fjölskyldunni geti lesið eða skrifað tengiliðalistann þinn, og engin inntakslína fyrir hana að nota.

Ef þú ert að meta þetta alvarlega: lestu /docs áður en þú leser meira af þessari vefsíðu. API er heiðarlega lýsingin á því hvað varan gerir, og hver fullyrðing á þessum síðum samsvarar leið eða hnútagerð sem þú getur fundið þar. Þegar skema breytist, breytast þessar síður.