ConnectWiz + API i webhookovi

Integracija u radu

API koji prodajemo isti je API koji i sami koristimo

Cijela je platforma opisana jednim OpenAPI ugovorom iz kojeg se generiraju naš panel i mobilna aplikacija – bez skrivenih krajnjih točaka i bez razmimoilaženja s dokumentacijom. Na njemu stoje Commerce API ključevi s opsezima, osigurani webhook okidači i tijekovi koji zovu vaše sustave.

Jedan OpenAPI ugovor API ključevi s opsezima Webhookovi provjereni HMAC-om
API i webhookovi × ConnectWiz
Sadržaj poruke je podatak, nikad naredba
Ključ s opsegom: čitanje kataloga · upis narudžbi
Webhook → provjera HMAC-om → tijek kreće
REST korak tijeka zove vaš API
1
Mjerodavni OpenAPI ugovor – ista datoteka iz koje se generiraju naš panel i mobilne aplikacije
3
Commerce opsega – čitanje kataloga, čitanje narudžbi, upis narudžbi – izdaju se po ključu
100
Najviše redaka po čitanju, ograničeno na poslužitelju – parametar limita se provjerava, nikad mu se ne vjeruje
50
Stavki po narudžbi kroz API – objavljena granica, a ne ona koju otkrijete u hodu

Programeri

Što točno radi

Jedan mjerodavni ugovor

Platformu opisuje jedan jedini OpenAPI 3 dokument; iz njega se generiraju naši TypeScript klijenti – dokumentacija se ne može razići sa stvarnošću jer je stvarnost izgrađena iz dokumentacije.

Commerce API ključevi

Ključevi koje izdaje tenant, s izričitim opsezima – čitanje kataloga, čitanje narudžbi, upis narudžbi – pokreću vašu vlastitu trgovinu ili aplikaciju na istom sustavu narudžbi, uz cijene koje se uvijek izračunavaju na poslužitelju.

Dolazni webhookovi, osigurani

Svaki webhook okidač tijeka ima vlastiti URL i tajnu, provjeru HMAC-om nad sirovim tijelom zahtjeva i zaštitu od ponavljanja. Sadržaj poruke smije imenovati osobu, ali nikad ne može upravljati unutrašnjošću tijeka.

Odlazni promet kroz tijekove

REST korak zove vaše sustave točno u trenucima koje nacrtate na platnu – narudžba je predana, privola dana, termin rezerviran.

Tehnička strana

Odluke o dizajnu API-ja, jasno rečene

Cijene nikad ne dolaze od klijenta

Zahtjev za narudžbu kaže što i koliko – naziv i cijena čitaju se iz kataloga u tom trenutku, na poslužitelju, i upisuju na stavku kao snimka stanja. Izmijenjeni zahtjev ne može izmisliti popust.

Prvo mogućnosti, pa pozivi

Svako mjesto integracije objavljuje ugovor o mogućnostima – može li povezati po broju telefona, izlistati gostujuće narudžbe, stvoriti narudžbu? – a poziv preko objavljenog „ne” odmah baca grešku umjesto da zakaže negdje duboko.

Greške koje nešto znače

Prijenosni sloj razlikuje „nije ovlašten” od „usluga ne radi” – pa se „trgovina je nedostupna” nikad ne prikaže kao „ovaj kupac nikad ništa nije kupio”. Imenovane greške razlika su između API-ja i pogađanja.

Webhookovi otporni na ponavljanje

Svaki dolazni događaj prije obrade zauzme jedinstven ključ u evidenciji idempotentnosti – ponovljena ili presnimljena isporuka umire na sloju baze, a ne u vašoj automatizaciji.

Ključevi u sažetku, tajne u opsezima

API ključevi pohranjeni su kao sažetci, a na vratima se iz njih mogu iščitati samo sažetak i opsezi – procurjeli redak baze ne imenuje nijedan radni prostor i ne otključava ništa izvan svojih opsega.

Nacrti i potvrde su izričiti

Stvaranje narudžbe prima izričit parametar potvrde – javni API prema zadanim postavkama stvara potvrđenu narudžbu, a tijekovi u panelu mogu pripremiti nacrt – pa je „je li ovo stvarno?” polje, a ne dogovor.

Postavljanje

Kako se povezuje

01

Izdajte ključ

U panelu napravite Commerce API ključ s opsegom; jednako ga lako i povučete.

02

Spojite webhook

Napravite tijek s webhook okidačem; zahtjeve potpisujte njegovom tajnom.

03

Zovite prema van

Dodajte REST korake ondje gdje vaši sustavi trebaju saznati što se dogodilo.

Bolje zajedno

S čime se kombinira

Flows

Webhook okidačima pokreću se tijekovi; REST koraci zovu vaše sustave natrag u trenucima koje sami nacrtate – dolazna i odlazna automatizacija dijele jedno platno.

Commerce

Naš katalog i sustav narudžbi iza API-ja isti su oni koje koriste i chat trgovina i AI – jedna istina o narudžbi, četvera vrata.

Vaša vlastita trgovina

Timovi već danas na Commerce API-ju vode headless trgovine – put koji stranica Shopify pošteno preporučuje dok se gradi izvorni konektor.

Sigurnost i jamstva

Dosadna jamstva

HMAC nad sirovim tijelom zahtjeva

Provjera webhooka potpisuje sirovo tijelo zahtjeva tajnom koja pripada tom okidaču i uspoređuje ga u konstantnom vremenu – raščlanjivanje počinje tek nakon dokaza.

Sadržaj poruke je podatak, nikad naredba

Sadržaj webhook poruke smije se pozvati na osobu, ali nikad ne može upravljati unutrašnjošću tijeka, mijenjati upite ni pozivati alate. Granica između podataka i uputa arhitektonska je, a ne stvar ponašanja.

Ograničenja brzine na svim vratima

Javne krajnje točke podliježu standardnom usporavanju, a ograničenja čitanja režu se na poslužitelju – klijent koji se loše ponaša šteti sebi, ne platformi.

Sitna slova bez uljepšavanja

Granice, jasno rečene

Zasad bez jednog velikog izvora događaja

Općeniti webhook niz na koji se pretplatite za sve nije napravljen – odlazni se događaji danas šalju kroz korake tijeka. Piše ovdje da nijedan prodajni razgovor ne bi morao nagovještavati drukčije.

Ograničena čitanja, namjerno

Čitanje vraća najviše 100 redaka uz kursor – API je građen za operativnu integraciju, a ne za masovni izvoz. Potreba za masovnim izvozom tema je za razgovor, a ne rupa u pravilima.

Česta pitanja o API-ju i webhookovima

Odgovori bez okolišanja

Više odgovora nudi stranica Česta pitanja, a za sve ostalo – pitajte nas izravno.

Platformu opisuje jedan OpenAPI 3 ugovor – ista datoteka iz koje naš web panel i mobilna aplikacija generiraju svoje tipove. Ono s čime se integrirate ono je na čemu i sami radimo.

Tajnom za svaki okidač, provjerom HMAC-om nad sirovim tijelom zahtjeva i zaštitom od ponavljanja kroz evidenciju idempotentnosti. I po pravilu, sadržaj poruke je podatak: smije se pozvati na osobu, ali nikad ne zapovijeda automatizaciji.

Može, kroz REST korake tijeka, koji se okidaju u trenucima koje odaberete na platnu. Općeniti odlazni webhook niz na planu je razvoja i namjerno ga ne obećavamo dok ne bude gotov.

Možete – čitanje kataloga i upis narudžbi podržan su put, uz cijene koje se izračunavaju na poslužitelju i ključeve s opsezima koje možete povući za svako mjesto posebno. Granice od 50 stavki i 100 redaka objavljene su da biste ih uračunali u dizajn, a ne da biste se o njih spotaknuli.

Isporuke su kod nas idempotentne – evidencija prepozna ponavljanje i odbaci ga, pa vaši sustavi mogu sigurno pokušati ponovno. Odlazni REST koraci iz tijekova imaju vlastito pravilo ponavljanja, a greške se prikazuju na pokretanju tijeka.

Pošteno povezano vrijedi više od glasno povezanog.

Svaka je integracija ovdje opisana onim što stvarno radi – smjer, vlasništvo i ograničenja uključeni.