ConnectWiz + API in webhooki

Delujoča integracija

API, ki ga prodajamo, je API, ki ga uporabljamo sami

Celotna platforma je opisana v eni pogodbi OpenAPI, iz katere se generirata tudi naš panel in mobilna aplikacija – brez skritih končnih točk, brez razhajanja dokumentacije. Na tej osnovi: API-ključi za Commerce z omejenim obsegom, zavarovani sprožilci webhook in avtomatizacije, ki kličejo vaše sisteme.

Ena pogodba OpenAPI API-ključi z omejenim obsegom Webhooki, preverjeni s HMAC
API in webhooki × ConnectWiz
Vsebina je podatek, nikoli ukaz
Omejen ključ: branje kataloga · pisanje naročil
Webhook → HMAC preverjen → avtomatizacija se zažene
Korak REST v avtomatizaciji pokliče vaš API
1
Pogodba OpenAPI kot edini vir resnice – iz iste datoteke se generirajo tudi naš panel in mobilne aplikacije
3
Obsegi za Commerce – branje kataloga, branje naročil, pisanje naročil – dodeljeni za vsak ključ posebej
100
Največ vrstic na branje, omejeno na strežniku – parameter limit se preveri, nikoli se mu slepo ne zaupa
50
Postavk v naročilu prek API-ja – meja, ki jo povemo vnaprej, da je ne odkrijete po nesreči

Za razvijalce

Kaj natančno počne

Ena pogodba kot vir resnice

Platformo opisuje en sam dokument OpenAPI 3, iz katerega se generirajo tudi naši odjemalci v TypeScriptu – dokumentacija se ne more oddaljiti od resničnosti, ker je resničnost zgrajena iz dokumentacije.

API-ključi za Commerce

Ključi, ki jih izda najemnik, z izrecno določenim obsegom – branje kataloga, branje naročil, pisanje naročil – poganjajo vašo lastno spletno trgovino ali aplikacijo na istem mehanizmu naročil, cene pa se vedno določijo na strežniku.

Dohodni webhooki, zavarovani

Vsak sprožilec webhook v avtomatizaciji ima svoj URL in skrivnost, preverjanje HMAC nad surovim telesom zahteve in zaščito pred ponovnim predvajanjem. Vsebina lahko poimenuje osebo, nikoli pa ne more krmiliti notranjosti avtomatizacije.

Navzven prek avtomatizacij

Korak REST pokliče vaše sisteme natanko v trenutkih, ki jih narišete na platnu – ob oddanem naročilu, dani privolitvi, opravljeni rezervaciji.

Tehnično ozadje

Načela oblikovanja API-ja, jasno povedana

Cene nikoli ne pridejo od odjemalca

Zahteva za naročilo pove, kaj in koliko – ime in cena se v tistem trenutku prebereta iz kataloga, na strežniku, in se zapišeta na postavko kot posnetek stanja. Ponarejena zahteva si popusta ne more izmisliti.

Zmožnosti pred klici

Vsaka integracijska površina objavi pogodbo o zmožnostih – ali zna iskati po telefonski številki, izpisati naročila gostov, ustvarjati naročila? – in klic mimo izrecnega »ne« takoj vrže napako, namesto da bi spodletel nekje globoko v sistemu.

Napake, ki nekaj pomenijo

Prenosni sloj loči »nepooblaščeno« od »storitev ne deluje« – zato se »trgovina ni dosegljiva« nikoli ne prikaže kot »ta stranka ni nikoli nič kupila«. Poimenovane napake so razlika med API-jem in ugibanjem.

Webhooki, odporni proti ponovnemu predvajanju

Vsak dohodni dogodek si pred obdelavo zagotovi edinstven ključ v evidenci idempotentnosti – ponovljena ali ponovno predvajana dostava obtiči na ravni baze podatkov, ne v vaši avtomatizaciji.

Ključi zgoščeni, skrivnosti omejene

API-ključi so shranjeni kot zgoščene vrednosti, na vhodu pa je mogoče razbrati le zgoščeno vrednost in obseg – ukradena vrstica iz baze ne razkrije nobenega delovnega prostora in ne odklene ničesar zunaj svojega obsega.

Osnutki in potrditve so izrecni

Ustvarjanje naročila sprejme izrecen parameter confirm – javni API privzeto potrdi, avtomatizacije v panelu lahko pripravijo osnutke – zato je »ali je to zares?« polje, ne dogovor.

Nastavitev

Kako se poveže

01

Izdajte ključ

V panelu ustvarite API-ključ za Commerce z omejenim obsegom; prav tako preprosto ga prekličete.

02

Povežite webhook

Ustvarite avtomatizacijo s sprožilcem webhook in zahteve podpišite z njeno skrivnostjo.

03

Pokličite navzven

Dodajte korake REST povsod, kjer morajo vaši sistemi izvedeti, kaj se je zgodilo.

Skupaj bolje

S čim se povezuje

Flows

Sprožilci webhook zaženejo avtomatizacije; koraki REST pokličejo vaše sisteme v trenutkih, ki jih narišete – dohodna in odhodna avtomatizacija si delita eno platno.

Commerce

Za API-jem stoji isti katalog in mehanizem naročil kot za trgovino v klepetu in AI – ena resnica o naročilih, štiri vrata.

Lastna spletna trgovina

Ekipe že danes poganjajo headless trgovine na Commerce API – to je pot, ki jo stran o Shopifyju iskreno priporoča, dokler nastaja izvorni povezovalnik.

Varnost in jamstva

Dolgočasna jamstva

HMAC nad surovim telesom

Preverjanje webhooka podpiše surovo telo zahteve s skrivnostjo posameznega sprožilca in primerja v konstantnem času – razčlenjevanje pride na vrsto šele po dokazu.

Vsebina je podatek, nikoli ukaz

Vsebina webhooka se lahko sklicuje na osebo, nikoli pa ne more krmiliti notranjosti avtomatizacije, prepisovati pozivov ali klicati orodij. Meja med podatki in navodili je arhitekturna, ne vedenjska.

Omejitve hitrosti na vseh vratih

Za javne končne točke velja standardno omejevanje hitrosti, omejitve branja pa so določene na strežniku – odjemalec, ki se slabo obnaša, upočasni sebe, ne platforme.

Drobni tisk brez olepševanja

Meje, jasno povedane

Vsega naenkrat še ni

Splošni vir webhookov, na katerega bi se bilo mogoče naročiti za vse dogodke, ni zgrajen – odhodni dogodki danes potekajo prek korakov v avtomatizacijah. Zapisano je tukaj, da tega noben prodajni klic ne bi nakazoval drugače.

Omejeno branje, namenoma

Branje vrne do 100 vrstic s kazalcem za nadaljevanje – API je zgrajen za operativno integracijo, ne za množični izvoz. Za množične potrebe se pogovorimo, luknje v pravilih ni.

Pogosta vprašanja o API-ju in webhookih

Odgovori brez ovinkarjenja

Več odgovorov najdete na strani Pogosta vprašanja, sicer pa pišite neposredno naši ekipi.

Platforma je opisana v eni pogodbi OpenAPI 3 – iz iste datoteke generirata svoje tipe tudi naš spletni panel in mobilna aplikacija. Integrirate se z natanko tistim, na čemer tečemo sami.

S skrivnostjo za vsak sprožilec, preverjanjem HMAC nad surovim telesom in zaščito pred ponovnim predvajanjem prek evidence idempotentnosti. Po pravilu pa je vsebina podatek: lahko se sklicuje na osebo, nikoli pa ne more ukazovati avtomatizaciji.

Prek korakov REST v avtomatizacijah, ki se sprožijo v trenutkih, ki jih izberete na platnu. Splošni odhodni vir webhookov je v načrtu razvoja in ga namenoma ne obljubljamo, dokler ni na voljo.

Da – branje kataloga in pisanje naročil sta podprta pot, cene se določijo na strežniku, ključe z omejenim obsegom pa lahko prekličete za vsako površino posebej. Meji 50 postavk in 100 vrstic sta navedeni, da ju upoštevate pri načrtovanju in se ob njiju ne spotaknete.

Dostave so pri nas idempotentne – evidenca prepozna ponovitev in jo zavrže, zato lahko vaši sistemi varno poskusijo znova. Odhodni koraki REST v avtomatizacijah imajo svoje pravilo ponovnih poskusov, napake pa so vidne pri izvajanju avtomatizacije.

Poštena povezava je več vredna od glasne.

Vsaka integracija je tu opisana s tem, kar zares počne – vključno s smerjo, lastništvom in omejitvami.