ConnectWiz + API dhe webhook-e

Integrim aktiv

API-ja që shesim është API-ja që përdorim vetë

E gjithë platforma përshkruhet në një kontratë të vetme OpenAPI, nga e cila gjenerohen paneli ynë dhe aplikacioni celular – pa endpoint-e të fshehura, pa dokumentacion që mbetet pas. Mbi të: çelësa Commerce API me leje të kufizuara, nxitës webhook të siguruar dhe rrjedha që thërrasin sistemet tuaja.

Një kontratë e vetme OpenAPI Çelësa API me leje të kufizuara Webhook-e të verifikuara me HMAC
API dhe webhook-e × ConnectWiz
Payload-i është e dhënë, kurrë urdhër
Çelës i kufizuar: lexim i katalogut · shkrim i porosive
Webhook → HMAC i verifikuar → nis rrjedha
Hapi REST i rrjedhës thërret API-në tuaj
1
Kontrata zyrtare OpenAPI – i njëjti skedar nga i cili gjenerohen paneli ynë dhe aplikacionet celulare
3
Leje Commerce – lexim i katalogut, lexim i porosive, shkrim i porosive – të dhëna për çdo çelës
100
Rreshta në maksimum për çdo lexim, të kufizuar në server – parametri limit validohet, nuk merret kurrë si i besuar
50
Artikuj për porosi përmes API-së – kufi i deklaruar, jo i zbuluar rastësisht

Zhvilluesit

Çfarë bën, saktësisht

Një kontratë e vetme zyrtare

Një dokument i vetëm OpenAPI 3 e përshkruan platformën; klientët tanë TypeScript gjenerohen prej tij – dokumentacioni nuk mund të largohet nga realiteti, sepse realiteti ndërtohet nga dokumentacioni.

Çelësat e Commerce API

Çelësa që i lëshon vetë hapësira juaj e punës, me leje të shprehura qartë – lexim i katalogut, lexim i porosive, shkrim i porosive – vënë në punë dyqanin ose aplikacionin tuaj mbi të njëjtin motor porosish, me çmimet gjithmonë të përcaktuara në server.

Webhook-e hyrëse, të siguruara

Çdo nxitës webhook i një rrjedhe ka URL-në dhe sekretin e vet, verifikim HMAC mbi trupin e papërpunuar të kërkesës dhe mbrojtje nga ripërsëritja. Një payload mund të përmendë një person; nuk mund ta drejtojë kurrë logjikën e brendshme të rrjedhës.

Trafik dalës përmes rrjedhave

Hapi REST thërret sistemet tuaja pikërisht në momentet që vizatoni në kanavacë – porosi e bërë, pëlqim i dhënë, rezervim i kryer.

Ana teknike

Parimet e projektimit të API-së, të shkruara qartë

Çmimet nuk vijnë kurrë nga klienti

Një kërkesë porosie thotë vetëm çfarë dhe sa – emri dhe çmimi lexohen nga katalogu në atë moment, në server, dhe shkruhen në rresht si fotografi e çastit. Një kërkesë e manipuluar nuk mund të shpikë një zbritje.

Aftësitë para thirrjeve

Çdo pikë integrimi publikon një kontratë aftësish – a mund të gjejë përputhje sipas telefonit, të listojë porositë e vizitorëve, të krijojë porosi? – dhe një thirrje përtej një “jo”-je të deklaruar kthen gabim menjëherë, në vend që të dështojë diku thellë.

Gabime që thonë diçka

Shtresa e transportit e dallon “pa autorizim” nga “shërbimi nuk punon” – ndaj “dyqani nuk arrihet” nuk shfaqet kurrë si “ky klient nuk ka blerë asgjë”. Gabimet me emër janë ajo që e dallon një API nga një lojë me hamendësime.

Webhook-e të mbrojtura nga ripërsëritja

Çdo ngjarje hyrëse zë një çelës unik në regjistrin e idempotencës para përpunimit – një dërgesë e riprovuar ose e ripërsëritur ndalet në shtresën e bazës së të dhënave, jo në automatizimin tuaj.

Çelësa të hash-uar, sekrete të kufizuara

Çelësat API ruhen si hash, dhe te dera mund të lexohen vetëm hash-i dhe lejet – një rresht i rrjedhur nga baza e të dhënave nuk tregon asnjë hapësirë pune dhe nuk hap asgjë përtej lejeve të veta.

Draftet dhe konfirmimet janë të shprehura qartë

Krijimi i porosisë kërkon një parametër të qartë konfirmimi – API-ja publike si parazgjedhje konfirmon, rrjedhat në panel mund të përgatisin drafte – ndaj “a është kjo e vërtetë?” është një fushë, jo një marrëveshje e heshtur.

Konfigurimi

Si lidhet

01

Krijoni një çelës

Krijoni në panel një çelës Commerce API me leje të kufizuara; po aq lehtë e revokoni.

02

Lidhni një webhook

Krijoni një rrjedhë me nxitës webhook; nënshkruajini kërkesat me sekretin e tij.

03

Thërrisni jashtë

Shtoni hapa REST aty ku sistemet tuaja duhet të marrin vesh.

Më mirë së bashku

Me çfarë kombinohet

Flows

Nxitësit webhook nisin rrjedha; hapat REST thërrasin sistemet tuaja në momentet që vizatoni – automatizimi hyrës dhe ai dalës ndajnë të njëjtën kanavacë.

Commerce

Edhe motori i katalogut dhe i porosive pas API-së është i njëjti që përdorin dyqani në chat dhe AI-ja – një e vërtetë e vetme për porositë, katër dyer.

Dyqani juaj më vete

Ekipet ndërtojnë sot dyqane headless mbi Commerce API – kjo është rruga që e rekomandon me ndershmëri faqja për Shopify derisa të ndërtohet konektori native.

Siguria dhe garancitë

Garancitë e mërzitshme

HMAC mbi trupin e papërpunuar

Verifikimi i webhook-ut e nënshkruan trupin e papërpunuar të kërkesës me një sekret të veçantë për çdo nxitës dhe krahason në kohë konstante – analiza e përmbajtjes bëhet vetëm pas provës.

Payload-i është e dhënë, kurrë urdhër

Payload-i i një webhook-u mund t’i referohet një personi; nuk mund të drejtojë kurrë logjikën e brendshme të rrjedhës, të rishkruajë prompt-e apo të thërrasë mjete. Kufiri mes të dhënave dhe udhëzimeve është arkitekturor, jo çështje sjelljeje.

Kufij shpejtësie në çdo derë

Endpoint-et publike kanë kufizim standard të shpejtësisë, dhe kufijtë e leximit vendosen në server – një klient që sillet keq dëmton veten, jo platformën.

Kushtet, pa zbukurime

Kufijtë, të shkruar qartë

Ende pa rrjedhë të plotë ngjarjesh

Një rrjedhë e përgjithshme webhook, ku abonoheni për gjithçka, nuk është ndërtuar – sot ngjarjet dalëse kalojnë përmes hapave të rrjedhave. E shkruajmë këtu, që asnjë telefonatë shitjeje të mos lërë të kuptohet ndryshe.

Lexime të kufizuara, qëllimisht

Leximet kthejnë deri në 100 rreshta me kursor – API-ja është ndërtuar për integrim operacional, jo për eksport masiv. Për nevoja masive flasim bashkë; nuk kërkohen rrugë anësore.

Pyetje të shpeshta për API-në dhe webhook-et

Përgjigje të drejtpërdrejta

Më shumë përgjigje gjeni te rubrika Pyetje të shpeshta, ndërsa për çdo gjë tjetër na shkruani drejtpërdrejt.

Platforma përshkruhet në një kontratë të vetme OpenAPI 3 – i njëjti skedar nga i cili paneli ynë në ueb dhe aplikacioni celular gjenerojnë tipet e tyre. Ajo me të cilën integroheni ju është ajo mbi të cilën punojmë ne.

Sekrete të veçanta për çdo nxitës, verifikim HMAC mbi trupin e papërpunuar dhe mbrojtje nga ripërsëritja përmes një regjistri idempotence. Dhe si rregull, payload-i është e dhënë: mund t’i referohet një personi, kurrë të komandojë automatizimin.

Po, përmes hapave REST të rrjedhave, që ekzekutohen në momentet që zgjidhni në kanavacë. Një rrjedhë e përgjithshme webhook-esh dalëse është në planin e zhvillimit dhe qëllimisht nuk premtohet derisa të lëshohet.

Po – leximi i katalogut dhe shkrimi i porosive janë rruga e mbështetur, me çmimet të përcaktuara në server dhe çelësa me leje të kufizuara që mund t’i revokoni për secilën pikë. Kufijtë prej 50 rreshtash dhe 100 rreshtash janë të deklaruar, që ta projektoni sistemin duke i pasur parasysh e jo të pengoheni prej tyre.

Dërgesat janë idempotente nga ana jonë – regjistri e njeh një ripërsëritje dhe e hedh poshtë, ndaj sistemet tuaja mund të riprovojnë pa rrezik. Hapat REST dalës të rrjedhave kanë rregullat e tyre të riprovimit, dhe dështimet shfaqen në ekzekutimin e rrjedhës.

Një integrim i ndershëm vlen më shumë se një integrim i zhurmshëm.

Çdo integrim këtu përshkruhet sipas asaj që bën realisht – bashkë me drejtimin, pronësinë dhe kufijtë.