ConnectWiz + API og webhooks

Virk tenging

API-ið sem við seljum er API-ið sem við notum

Öllu kerfinu er lýst í einum OpenAPI-samningi sem okkar eigin stjórnborð og farsímaapp eru búin til út frá – engir faldir endapunktar, engin skjöl sem úreldast. Ofan á það: Commerce API-lyklar með afmörkuðum heimildum, tryggðar webhook-kveikjur og flæði sem kalla á kerfin þín.

Byrja frítt Allar tengingar
Einn OpenAPI-samningur API-lyklar með afmörkuðum heimildum Webhook-köll sannreynd með HMAC
API og webhooks × ConnectWiz
Innihald er gögn, aldrei skipanir
Afmarkaður lykill: lesa vörulista · skrifa pantanir
Webhook-kall → sannreynt með HMAC → flæði hefst
REST-skref í flæði kallar á API-ið þitt
1
gildandi OpenAPI-samningur – sama skrá og okkar eigið stjórnborð og farsímaöpp eru búin til út frá
3
Commerce-heimildir – lesa vörulista, lesa pantanir, skrifa pantanir – veittar fyrir hvern lykil
100
raðir að hámarki í hverri lesningu, takmarkað á netþjóni – limit-færibreyta er sannprófuð, henni aldrei treyst
50
línur að hámarki í hverri pöntun um API-ið – uppgefið þak, ekki þak sem þú rekst á

Forritarar

Virknin – nákvæmlega

Einn gildandi samningur

Eitt OpenAPI 3-skjal lýsir kerfinu; okkar eigin TypeScript-biðlarar eru búnir til út frá því – skjölin geta ekki fjarlægst raunveruleikann því raunveruleikinn er smíðaður úr skjölunum.

Commerce API-lyklar

Lyklar sem vinnusvæðið gefur út með skýrum heimildum – lesa vörulista, lesa pantanir, skrifa pantanir – knýja þína eigin netverslun eða app á sömu pöntunarvél, og verð eru alltaf fundin á netþjóninum.

Innkomin webhook-köll, tryggð

Hver webhook-kveikja í flæði hefur eigin slóð og leyndarorð, HMAC-sannprófun á óunnu meginmáli og vörn gegn endurspilun. Innihald getur nefnt manneskju; það getur aldrei stýrt innviðum flæðisins.

Út í gegnum flæði

REST-skrefið kallar á kerfin þín nákvæmlega á þeim augnablikum sem þú teiknar á strigann – pöntun gerð, samþykki veitt, tími bókaður.

Tæknilega hliðin

Afstaða okkar í API-hönnun, sögð hreint út

Verð koma aldrei frá biðlaranum

Pöntunarbeiðni segir hvað og hversu mikið – heiti og verð eru lesin úr vörulistanum á því augnabliki, á netþjóninum, og skrifuð á línuna sem skyndimynd. Fikt í beiðninni getur ekki búið til afslátt.

Geta á undan köllum

Hver tengiflötur birtir getusamning – getur hann parað eftir símanúmeri, listað pantanir gesta, stofnað pantanir? – og kall fram hjá yfirlýstu „nei“ kastar villu strax í stað þess að bregðast einhvers staðar djúpt inni.

Villur sem merkja eitthvað

Flutningslagið greinir á milli „óheimilt“ og „þjónusta liggur niðri“ – svo „ekki næst í verslunina“ birtist aldrei sem „þessi viðskiptavinur hefur aldrei keypt neitt“. Nefndar villur eru munurinn á API og ágiskunarleik.

Webhook-köll sem þola endurspilun

Hver innkominn atburður tekur frá einkvæman lykil í idempotency-færsluskrá áður en unnið er úr honum – endurtekin eða endurspiluð sending stöðvast í gagnagrunnslaginu, ekki í sjálfvirkninni þinni.

Lyklar tættir, leyndarmál afmörkuð

API-lyklar eru geymdir sem tætigildi og aðeins tætigildið og heimildirnar eru lesanlegar við dyrnar – röð sem lekur úr gagnagrunninum nefnir ekkert vinnusvæði og opnar ekkert umfram heimildir sínar.

Drög og staðfestingar eru skýrar

Stofnun pöntunar tekur skýra confirm-færibreytu – opinbera API-ið er sjálfgefið staðfest, flæði í stjórnborðinu geta útbúið drög – svo „er þetta raunverulegt?“ er reitur, ekki venja.

Uppsetning

Svona er tengt

01

Gefðu út lykil

Búðu til Commerce API-lykil með afmörkuðum heimildum í stjórnborðinu; afturkallaðu hann jafn auðveldlega.

02

Tengdu webhook

Búðu til flæði með webhook-kveikju; undirritaðu beiðnir með leyndarorði hennar.

03

Kallaðu til baka út

Bættu við REST-skrefum þar sem kerfin þín þurfa að frétta af því.

Sterkara saman

Samspil við aðra virkni

Flows

Webhook-kveikjur ræsa flæði; REST-skref kalla aftur á kerfin þín á þeim augnablikum sem þú teiknar – sjálfvirkni inn og út deilir einum striga.

Commerce

Á bak við API-ið er vörulista- og pöntunarvélin sú sama og spjallverslunin og gervigreindin nota – einn sannleikur um pantanir, fernar dyr.

Þín eigin netverslun

Teymi keyra headless-netverslanir á Commerce API í dag – sú leið sem Shopify-síðan mælir heiðarlega með á meðan innbyggða tengingin er í smíðum.

Öryggi og loforð

Leiðinlegu loforðin

HMAC á óunnu meginmáli

Sannprófun webhook-kalla undirritar óunnið meginmál beiðninnar með leyndarorði hverrar kveikju og ber saman á föstum tíma – þáttun fer aðeins fram eftir sönnun.

Innihald er gögn, aldrei skipanir

Innihald webhook-kalls getur vísað til manneskju; það getur aldrei stýrt innviðum flæðis, endurskrifað fyrirmæli eða kallað á verkfæri. Mörkin á milli gagna og fyrirmæla liggja í högun kerfisins, ekki í hegðun.

Hraðatakmörk á öllum dyrum

Opinberir endapunktar eru með hefðbundna hraðastýringu og lestrartakmörk eru fest á netþjóninum – biðlari sem hagar sér illa skaðar sjálfan sig, ekki kerfið.

Smáa letrið, umbúðalaust

Mörkin, sögð hreint út

Engin brunaslanga enn

Almennt webhook-streymi þar sem þú gerist áskrifandi að öllu er ekki smíðað – atburðir út fara í dag um skref í flæðum. Sagt hér, svo ekkert sölusímtal þurfi að gefa annað í skyn.

Takmarkaðar lesningar, viljandi

Lesningar skila allt að 100 röðum með bendli – API-ið er smíðað fyrir tengingar í daglegum rekstri, ekki fjöldaútflutning. Þörf fyrir fjöldaútflutning er samtal, ekki smuga.

Spurt og svarað um API og webhooks

Beinskeytt svör

Lestu meira á síðunni Spurt og svarað, eða spurðu okkur beint.

Kerfinu er lýst í einum OpenAPI 3-samningi – sömu skrá og vefstjórnborðið okkar og farsímaappið byggja tegundir sínar á. Það sem þú tengist er það sem við keyrum sjálf á.

Leyndarorð fyrir hverja kveikju, HMAC-sannprófun á óunnu meginmáli og vörn gegn endurspilun með idempotency-færsluskrá. Og samkvæmt reglu er innihald gögn: það getur vísað til manneskju en aldrei gefið sjálfvirkninni skipanir.

Í gegnum REST-skref í flæðum, sem fara af stað á þeim augnablikum sem þú velur á striganum. Almennt webhook-streymi út er á vegvísinum og viljandi ekki lofað fyrr en það er komið út.

Já – lestur úr vörulista og skrif pantana eru studda leiðin, verð eru fundin á netþjóninum og lyklar með afmörkuðum heimildum sem þú getur afturkallað fyrir hvern flöt. Þökin, 50 línur og 100 raðir, eru uppgefin svo þú hannir út frá þeim í stað þess að reka þig á þau.

Sendingar eru idempotent okkar megin – færsluskráin þekkir endurspilun og hendir henni, svo kerfin þín geta endurtekið án áhættu. REST-skref út úr flæðum hafa eigin endurtilraunareglu og villur birtast á keyrslu flæðisins.

Heiðarleg tenging er betri en hávær.

Hverri tengingu hér er lýst út frá því sem hún gerir í raun – stefna, eignarhald og takmörk meðtalin.

Byrja frítt Allar tengingar