Shopify API integracija: kaip ji veikia, naudojimo atvejai ir kaip pradėti
Shopify API integracija sujungia parduotuvę su kita sistema, kad produktai, užsakymai, klientai, užsakymų vykdymo duomenys ar siuntų įvykiai galėtų judėti tarp jų be pakartotinio rankinio duomenų įvedimo. Įprastas įgyvendinimas pradedamas nuo Shopify programėlės arba privačios operacinės paslaugos, naudojami tinkami API leidimai, o pakeitimai, kai praktiška, gaunami per žiniatinklio kablius (webhooks). Taip pat pridedamos autentifikavimo, užklausų dažnio ribojimo, pakartotinių bandymų ir pasikartojančių įvykių apsaugos. Siuntų matomumui kartu su Shopify užsakymų ir užsakymų vykdymo duomenimis galima naudoti sekimo API, pvz., 17TRACK API.
Tinkamas integracijos dizainas priklauso nuo automatizuojamo verslo proceso. Parduotuvei, kuriai reikia tik firminio siuntų sekimo puslapio, taikomi kitokie reikalavimai nei mažmenininkui, sinchronizuojančiam Shopify su ERP, sandėlio valdymo sistema, klientų aptarnavimo platforma ar kelių vežėjų sekimo paslauga.
Ką atlieka Shopify API integracija
API integracija leidžia dviem sistemoms keistis struktūrizuota informacija naudojant autentifikuotas užklausas ir pranešimus apie įvykius. Įprastoje elektroninės prekybos darbo eigoje Shopify išlieka kai kurių prekybos duomenų pagrindiniu šaltiniu, o kita platforma valdo specializuotą procesą.
- Shopify į kitą sistemą: užsakymai, produktų informacija, klientų duomenys, užsakymų vykdymo įrašai ir pasirinkti užsakymų įvykiai gali būti siunčiami į ERP, sandėlio platformą, analitikos sistemą ar klientų aptarnavimo įrankį.
- Iš kitos sistemos į Shopify: atsargų atnaujinimai, užsakymų vykdymo patvirtinimai, sekimo numeriai ir užsakymų vykdymo būsenos pakeitimai gali būti įrašomi atgal į Shopify, kai integracija turi reikiamus leidimus, o paskirties darbo eiga tai palaiko.
- Įvykiai programai: žiniatinklio kabliai gali informuoti integraciją, kai įvyksta pasirinkti pakeitimai, todėl nebereikia nuolat tikrinti Shopify dėl kiekvieno galimo atnaujinimo.
- Sekimo duomenys klientų patirčiai: vežėjų įvykius sekimo paslauga gali suvienodinti ir tada parodyti parduotuvės užsakymo būsenos darbo eigoje, pranešimų sistemoje ar pagalbos sąsajoje.
API automatiškai nenusprendžia, kurie įrašai turi būti perduodami, kaip turi būti susieti laukai ar kas turi įvykti sistemoms nesutariant. Tai yra integracijos dizaino sprendimai. Todėl patikimas projektas apima verslo taisykles, duomenų nuosavybę, stebėseną ir atkūrimo procesą, o ne tik dviejų galinių taškų sujungimą.
Kaip veikia integracija
1. Pasirinkite integracijos modelį
Yra trys įprasti modeliai.
- Gimtoji Shopify programėlė: prekybininko įdiegta programėlė tvarko autorizavimą ir naudoja Shopify API, kad pasiektų leidžiamus parduotuvės duomenis. Tai dažnai tinka, kai integracija bus naudojama keliose parduotuvėse.
- Individuali programėlė arba vidinė paslauga: įmonė sukuria integraciją savo parduotuvei ar organizacijai. Tai suteikia didesnę laukų susiejimo ir veiklos taisyklių kontrolę, tačiau savininkas vis tiek turi valdyti prisijungimo duomenis, leidimus, versijų pakeitimus ir patikimumą.
- Jungtis arba automatizavimo platforma: trečiosios šalies jungtis susieja Shopify su kita paslauga naudodama iš anksto sukurtas darbo eigas. Tai gali sutrumpinti įgyvendinimo laiką, tačiau sudėtingoms užsakymų vykdymo taisyklėms, dideliam įvykių kiekiui ar neįprastiems duomenų modeliams gali reikėti individualaus kūrimo.
Prieš pasirinkdami modelį, aprašykite susijusias sistemas, perduodamus įrašus, kiekvieno duomenų srauto kryptį ir priimtiną delsą. Sekimo atnaujinimas, gaunamas per kelias minutes, gali būti tinkamas klientams skirtam puslapiui, o atsargų sinchronizavimui gali reikėti griežtesnės veiklos kontrolės.
2. Sukurkite prieigą su mažiausia praktiškai reikalinga apimtimi
Shopify naudoja API prieigos apimtis, kad kontroliuotų, ką programa gali skaityti ar rašyti. Integracija turėtų prašyti tik dokumentuotoms funkcijoms reikalingų leidimų. Pavyzdžiui, paslauga, skaitanti užsakymų vykdymo informaciją, neturėtų automatiškai prašyti leidimo keisti nesusijusius produktų ar klientų duomenis.
Autentifikavimo duomenys priklauso nuo programėlės tipo ir dabartinių Shopify platformos reikalavimų. Shopify dokumentacija turėtų būti laikoma pagrindiniu šaltiniu apie palaikomą autorizavimo eigą, prieigos raktų tvarkymą ir dabartinę API versiją. Parduotuvės prisijungimo duomenis laikykite paslapčių valdymo sistemoje, o ne šaltinio kode, skaičiuoklėse, naršyklės saugykloje ar įprastuose konfigūracijos failuose.
3. Pasirinkite API ir duomenų modelį
Shopify teikia skirtingiems tikslams skirtas API. Admin GraphQL API yra pagrindinė administracinių parduotuvės duomenų parinktis ir leidžia programai prašyti laukų naudojant grafu pagrįstą užklausų modelį. Shopify taip pat dokumentuoja kitas API ir sąsajas konkretiems naudojimo atvejams, todėl tinkamą pasirinkimą reikėtų patikrinti dabartinėje dokumentacijoje, o ne numanyti iš senesnės mokymo medžiagos.
Pagrindinė dizaino užduotis – susieti verslo objektus tarp sistemų. Pavyzdžiui, Shopify užsakymas gali atitikti ERP užsakymą, sandėlio sistemos užsakymo vykdymo užklausą ir sekimo platformos siuntos įrašą. Šie objektai gali neturėti tų pačių identifikatorių ar būsenų žodyno. Išsaugokite pradinius kiekvienos sistemos ID ir nustatykite stabilų kryžminį ryšį, užuot derinę įrašus vien pagal kliento vardą ar užsakymo sumą.
4. Derinkite žiniatinklio kablius su kontroliuojamais API skaitymais
Žiniatinklio kabliai naudingi, kai sistemai reikia reaguoti į pakeitimus. Jie gali pradėti darbo eigą po atitinkamo Shopify įvykio, todėl nereikia nuolat tikrinti sistemos. Tačiau gaunamas žiniatinklio kablio pranešimas paprastai turėtų būti laikomas signalu patikrinti ir apdoroti pakeitimą, o ne įrodymu, kad visos tolesnės operacijos sėkmingai įvykdytos.
Patikima apdorojimo programa patikrina užklausą pagal Shopify dokumentuotą metodą, įrašo įvykį, patikrina, ar jis jau buvo apdorotas, ir įtraukia užduotį į eilę, kai apdorojimas gali užtrukti. Tada darbuotojas gali gauti reikiamą įrašą, pritaikyti verslo taisykles ir įrašyti rezultatą. Šis metodas padeda išvengti skirtųjų laiko limitų ir daro pakartotinius bandymus saugesnius.
5. Tvarkykite ribojimus, klaidas ir versijų pakeitimus
API užklausos gali nepavykti dėl laikinų tinklo problemų, pasibaigusių prisijungimo duomenų, netinkamų duomenų, leidimų pakeitimų, ribojimo ar API versijos perėjimo. Integracija turėtų atskirti laikinas klaidas nuo nuolatinių tikrinimo klaidų. Laikinas klaidas galima pakartoti taikant didėjančias pauzes, o dėl nuolatinių klaidų reikia įspėjimo, taisymo darbo eigos arba rankinės peržiūros.
Užklausų dažnio ribojimai yra techninio dizaino dalis, o ne paskutinis optimizavimas. Naudokite puslapiavimą, prašykite tik reikalingų laukų, venkite nereikalingo tikrinimo, grupuokite staigius užklausų srautus į eilę ir stebėkite atsakymų kodus bei apdorojimo delsą. Prieš vertinant gamybinį pajėgumą, dabartinius Shopify ribojimus ir veikimą reikėtų patikrinti oficialioje dokumentacijoje.
Dažniausi Shopify API integracijos naudojimo atvejai
Užsakymų ir užsakymų vykdymo sinchronizavimas
Užsakymų vykdymo integracija gali siųsti naujus užsakymus į sandėlį ar 3PL, o tada įrašyti užsakymų vykdymo patvirtinimus ir sekimo numerius atgal į Shopify. Svarbūs sprendimai yra tai, kada užsakymas tinkamas eksportuoti, kaip tvarkomi atšaukti ar pakeisti užsakymai ir kuri sistema po perdavimo valdo siuntos būseną.
Nelaikykite savaime suprantamu dalyku, kad sukurto užsakymo jau galima išsiųsti. Mokėjimo būsena, sukčiavimo patikra, atsargų paskirstymas, pristatymo adreso patvirtinimas ir užsakymo vykdymo vieta gali turėti įtakos išleidimo taisyklei.
Atsargų sinchronizavimas
Atsargų integracijos sinchronizuoja galimus kiekius tarp Shopify, sandėlių, prekyviečių ir vidinių sistemų. Naudingame dizaine apibrėžiamas atsargų šaltinis, saugos atsargos, rezervavimo elgsena ir konfliktų sprendimas. Be šių taisyklių dvi sistemos gali perrašyti viena kitą arba parodyti atsargas, kurios jau paskirtos.
Klientų aptarnavimas ir užsakymų paieška
Pagalbos platforma gali naudoti Shopify duomenis, kad agentai galėtų rasti užsakymą, peržiūrėti užsakymo vykdymo eigą ir nustatyti kitą veiksmą. Tai gali sumažinti poreikį perjunginėti skirtukus, tačiau klientų duomenys turėtų būti ribojami pagal pagalbos naudojimo atvejį. Prieš kopijuojant asmeninę informaciją į kitą platformą reikėtų peržiūrėti saugojimo, prieigos kontrolės ir privatumo reikalavimus.
Siuntų sekimas ir atnaujinimai po pirkimo
Shopify gali saugoti užsakymų ir jų vykdymo informaciją, o sekimo paslauga gali teikti konkretaus vežėjo siuntų įvykius ir suvienodintą būsenos vaizdą. Toks atskyrimas naudingas, kai prekybininkas dirba su keliais vežėjais arba siunčia tarptautiniu mastu. Integracija turėtų nuosekliai susieti vežėjo kodą, sekimo numerį, siuntos nuorodą ir įvykio būseną.
Prekybininkams, kurie nori paruoštos Shopify sekimo darbo eigos, o ne individualaus API projekto, atskirai galima įvertinti oficialią 17TRACK Shopify programėlę. Individualiai programai reikėtų patikrinti 17TRACK API dokumentaciją, kurioje pateikiami dabartiniai autentifikavimo, galinių taškų, sekimo ir paskyros reikalavimai. Programėlė ir API sprendžia susijusias, bet skirtingas įgyvendinimo problemas; vienos nereikėtų pateikti kaip kitos pakaitalo, prieš tai nepatikrinus reikiamos darbo eigos.
Praktinis darbo pradžios planas
- Aprašykite rezultatą verslo terminais. Pavyzdžiui: „Per nustatytą paslaugos laiką nusiųsti apmokėtus užsakymus į sandėlį“ arba „Parodyti klientams siuntos eigą, kai priskiriamas sekimo numeris“.
- Išvardykite sistemas ir savininkus. Nustatykite, kas valdo produktus, atsargas, užsakymus, jų vykdymą, sekimo įvykius ir klientų pranešimus.
- Sukurkite laukų žemėlapį. Įtraukite ID, laiko žymas, būsenų reikšmes, adresus, kiekius, vežėjų kodus, sekimo numerius ir klaidų laukus. Pažymėkite privalomus, pasirenkamus, tik skaitomus ir transformuojamus laukus.
- Patvirtinkite dabartinę dokumentaciją. Patikrinkite Shopify API versiją, autentifikavimo metodą, prieigos apimtis, žiniatinklio kablių reikalavimus, puslapiavimo veikimą ir užklausų dažnio ribojimus. Patikrinkite atitinkamą kiekvienos išorinės platformos dokumentaciją.
- Sukurkite ribotos apimties koncepcijos patikrą. Pradėkite nuo mažos bandomosios parduotuvės arba kontroliuojamo duomenų rinkinio. Prieš pridėdami visus objektų tipus patikrinkite autentifikavimą, vieną skaitymo kelią, vieną rašymo kelią, jei jo reikia, ir vieną įvykiais pagrįstą darbo eigą.
- Pridėkite idempotentiškumą ir sutikrinimą. Pasikartojantis žiniatinklio kablio pranešimas ar pakartotinis bandymas neturi sukurti pasikartojančių siuntų, klientų pranešimų ar atsargų koregavimų. Suplanuokite sutikrinimo patikras, kad rastumėte praleistus ar atmestus įrašus.
- Išbandykite veiklos išimtis. Įtraukite atšauktus užsakymus, pakeistus adresus, padalytas siuntas, dalinį užsakymo vykdymą, trūkstamus sekimo numerius, netinkamus vežėjų kodus, pasikartojančius įvykius, API ribojimą, pasibaigusius prisijungimo duomenis ir vėluojančius vežėjo atnaujinimus.
- Pradėkite naudoti su stebėsena. Stebėkite sėkmingus ir nesėkmingus įvykius, eilės amžių, API atsakymų klaidas, apdorojimo laiką ir įrašus, kuriems reikia rankinio veiksmo. Apibrėžkite, kas gauna įspėjimus ir kaip nesėkmės pakartojamos.
Kada naudoti jungtį, individualią programėlę ar sekimo API
| Parinktis | Paprastai tinka | Pagrindiniai patikrinimai prieš pasirenkant |
|---|---|---|
| Jungtis arba automatizavimo įrankis | Standartinėms darbo eigoms, kurioms reikia nedaug pritaikymo | Palaikomi objektai, įvykių delsos, klaidų tvarkymas, užduočių ribojimai ir duomenų saugojimas |
| Individuali Shopify programėlė arba paslauga | Išskirtinėms verslo taisyklėms, kelioms sistemoms ar kontroliuojamiems vidiniams procesams | Kūrimo atsakomybė, saugumas, stebėsena, API priežiūra ir bendra veiklos kaina |
| Sekimo API | Individualiai patirčiai po pirkimo arba siuntų matomumui | Vežėjų ir regionų reikalavimai, sekimo gyvavimo ciklas, atnaujinimų elgsena, ribojimai ir komercinės sąlygos |
Jungtis ne visada yra paprastesnė, jei darbo eigai reikia individualių pakartotinių bandymų ar sudėtingo sutikrinimo. Kita vertus, individuali integracija ne visada yra geresnė, jei reikalavimus jau atitinka standartinė ir gerai palaikoma programėlė. Patikimiausias pasirinkimas yra mažiausios apimties įgyvendinimas, atitinkantis duomenų, patikimumo, saugumo ir veiklos reikalavimus.
Saugumo ir patikimumo kontrolinis sąrašas
- Naudokite mažiausių privilegijų prieigos apimtis ir peržiūrėkite jas pasikeitus integracijai.
- Laikykite prieigos raktus ir paslaptis ne programos kode, o juos keiskite kontroliuojamu procesu.
- Patikrinkite žiniatinklio kablių autentiškumą pagal platformos dokumentaciją.
- Šifruokite perduodamus duomenis ir apribokite administracinę prieigą prie žurnalų bei klientų įrašų.
- Naudokite idempotentišką apdorojimą, kad pakartotiniai bandymai nekartotų šalutinių veiksmų.
- Audito ir sutikrinimo tikslais saugokite pirminių sistemų ID ir įvykių laiko žymas.
- Naudokite atskirus bandomosios ir gamybinės aplinkos prisijungimo duomenis ir nenaudokite tikrų klientų duomenų neformaliems bandymams.
- Prieš kopijuodami asmens duomenis į kitą paslaugą peržiūrėkite privatumo, saugojimo ir ištrynimo įsipareigojimus.
- Stebėkite API versijas ir suplanuokite atnaujinimus prieš pasikeičiant palaikomai versijai.
DUK
Ar Shopify API integracija yra tas pats, kas Shopify programėlės įdiegimas?
Ne. Shopify programėlė gali naudoti Shopify API, tačiau programėlės įdiegimas yra prekybininkui skirtas diegimo veiksmas. API integracija yra platesnis Shopify ir kitos sistemos ryšys. Ji gali būti įgyvendinta per viešą programėlę, individualią programėlę, vidinę paslaugą arba jungtį.
Kurią Shopify API turėčiau naudoti?
Pasirinkite API pagal duomenis ir darbo eigą, tada patvirtinkite dabartinę rekomendaciją Shopify dokumentacijoje. Administraciniams parduotuvės duomenims dažnai naudojama Admin GraphQL API, tačiau konkrečiam naudojimo atvejui būtina patikrinti autentifikavimą, leidimus, objektų prieinamumą ir versijos palaikymą.
Ar Shopify pati gali teikti vežėjų sekimo atnaujinimus?
Shopify gali saugoti užsakymų vykdymo ir sekimo informaciją, tačiau išsami sekimo patirtis priklauso nuo to, kaip siuntų įvykiai gaunami, suvienodinami, rodomi ir perduodami. Kelių vežėjų arba tarptautinei darbo eigai gali reikėti specializuotos sekimo paslaugos ar kito integracijos sluoksnio.
Ar turėčiau naudoti žiniatinklio kablius, ar tikrinimą?
Žiniatinklio kabliai paprastai naudingi reaguojant į pakeitimus, o kontroliuojami API skaitymai – tikrinimui, sutikrinimui ir atkūrimui. Gamybinėse integracijose dažniausiai naudojami abu metodai, o ne tik vienas iš jų.
Kiek laiko užtrunka Shopify API integracija?
Patikimo vieno termino nėra. Paprastą jungtį galima sukonfigūruoti greitai, o individualiai integracijai, apimančiai atsargas, užsakymų vykdymą, klientų duomenis, kelis vežėjus ir sutikrinimą, reikia daugiau projektavimo bei bandymų. Sistemų skaičius, išimčių taisyklės, saugumo peržiūra ir diegimo kontrolė yra geresni rodikliai nei vien Shopify ryšys.
