ConnectWiz + API ja webhookid
Live-integratsioonAPI, mida müüme, on API, mida ise kasutame
Kogu platvorm on kirjeldatud ühes OpenAPI lepingus, millest genereeritakse ka meie enda paneel ja mobiilirakendus – pole varjatud otspunkte ega dokumentatsiooni lahknemist koodist. Selle peal: piiratud õigustega Commerce API võtmed, turvatud webhooki käivitid ja vood, mis pöörduvad sinu süsteemide poole.
Arendajatele
Mida see teeb – täpselt
Üks leping kui tõeallikas
Platvormi kirjeldab üks OpenAPI 3 dokument ja meie enda TypeScripti kliendid genereeritakse sellest – dokumentatsioon ei saa tegelikkusest lahkneda, sest tegelikkus ehitatakse dokumentatsiooni järgi.
Commerce API võtmed
Tööruumi väljastatud võtmed selgesõnaliste õigustega – kataloogi lugemine, tellimuste lugemine, tellimuste kirjutamine – käitavad sinu enda vaateakent või rakendust samal tellimusmootoril ning hinnad arvutatakse alati serveri poolel.
Sissetulevad webhookid, turvatud
Igal voo webhooki käivitil on oma URL ja saladus, HMAC-kontroll üle töötlemata päringu keha ja kordusrünnete kaitse. Sisu võib nimetada inimest, kuid ei saa kunagi juhtida voo sisemust.
Väljapoole voogude kaudu
REST-samm pöördub sinu süsteemide poole täpselt neil hetkedel, mille lõuendile joonistad – tellimus esitatud, nõusolek antud, broneering tehtud.
Tehniline pool
API disaini põhimõtted, välja öeldud
Hinnad ei tule kunagi kliendilt
Tellimuse päring ütleb, mida ja kui palju – nimi ja hind loetakse samal hetkel serveri poolel kataloogist ja kirjutatakse tellimusreale hetktõmmisena. Võltsitud päring ei saa endale allahindlust välja mõelda.
Võimekus enne pöördumist
Iga integratsiooniliides avaldab oma võimekuste lepingu – kas see oskab siduda telefoninumbri järgi, näidata külalistellimusi, luua tellimusi? Pöördumine, mis eirab välja öeldud „ei“-d, viskab vea kohe, selle asemel et kusagil sügaval ebaõnnestuda.
Vead, millel on tähendus
Transpordikiht eristab olekut „volitamata“ olekust „teenus maas“ – nii ei kuvata „pood pole kättesaadav“ kunagi kui „see klient pole kunagi midagi ostnud“. Nimega vead on see, mis teeb API-st API ja mitte äraarvamismängu.
Kordamiskindlad webhookid
Iga sissetulev sündmus hõivab enne töötlemist idempotentsuse pearaamatus unikaalse võtme – uuesti saadetud või korratud kohaletoimetamine sureb andmebaasi tasemel, mitte sinu automaatikas.
Võtmed räsitud, saladused piiratud
API-võtmeid hoitakse räsidena ja uksel on lahendatavad ainult räsi ning õigused – lekkinud andmebaasirida ei nimeta ühtki tööruumi ega ava midagi peale oma õiguste.
Mustandid ja kinnitused on selgesõnalised
Tellimuse loomisel on selgesõnaline kinnitusparameeter: avalik API loob vaikimisi kinnitatud tellimuse, paneeli vood võivad jätta selle mustandiks. Nii on „kas see on päris?“ väli, mitte kokkulepe.
Seadistamine
Kuidas ühendus käib
Väljasta võti
Loo paneelis piiratud õigustega Commerce API võti – tühistada saad selle sama lihtsalt.
Ühenda webhook
Loo webhooki käivitiga voog ja allkirjasta päringud selle saladusega.
Anna teada väljapoole
Lisa REST-sammud sinna, kus sinu süsteemid peavad toimunust kuulma.
Koos veel parem
Millega see kokku sobib
Flows
Webhooki käiviti paneb käima voo; REST-sammud annavad sinu süsteemidele teada just neil hetkedel, mille lõuendile joonistad – sissetulev ja väljaminev automaatika jagavad üht lõuendit.
Commerce
API taga olev kataloogi- ja tellimusmootor on sama, mida kasutavad vestluspood ja tehisaru – üks tõde tellimuste kohta, neli ust.
Sinu enda pood
Tiimid käitavad Commerce API peal headless-poode juba täna – just seda teed soovitab Shopify leht ausalt, kuni natiivset konnektorit ehitatakse.
Turvalisus ja garantiid
Igavad garantiid
HMAC üle töötlemata keha
Webhooki kontroll allkirjastab töötlemata päringu keha käiviti enda saladusega ja võrdleb tulemust konstantse ajaga – parsimine algab alles pärast tõendust.
Sisu on andmed, mitte kunagi käsud
Webhooki sisu võib viidata inimesele, kuid ei saa kunagi juhtida voo sisemust, ümber kirjutada viipasid ega käivitada tööriistu. Piir andmete ja juhiste vahel on arhitektuurne, mitte käitumuslik.
Kiiruspiirangud igal uksel
Avalikel otspunktidel kehtib tavapärane piiramine ja lugemispiirangud kärbitakse serveri poolel – valesti käituv klient aeglustab iseennast, mitte platvormi.
Väike kiri, ausalt
Piirid, välja öeldud
Kõigi sündmuste voogu veel pole
Üldist „telli kõik“ webhooki voogu pole ehitatud – väljaminevad sündmused liiguvad täna voo sammude kaudu. Ütleme selle siin välja, et ükski müügikõne ei peaks vastupidisele vihjama.
Piiratud lugemised, teadlikult
Lugemine tagastab kuni 100 rida koos kursoriga – API on ehitatud igapäevaseks integratsiooniks, mitte massekspordiks. Massandmete vajadus on jutuajamise koht, mitte seaduselünk.
Ausalt ühendatud on parem kui valjult reklaamitud.
Iga integratsioon on siin kirjeldatud selle järgi, mida see päriselt teeb – koos suuna, omandi ja piirangutega.