ConnectWiz + API & Webhook

Integrasi aktif

API anu kami jual téh API anu kami paké

Sakabéh platform ditetepkeun dina hiji kontrak OpenAPI, sarta panel jeung aplikasi mobile kami sorangan dihasilkeun tina kontrak éta — euweuh endpoint siluman, euweuh dokuméntasi anu nyimpang. Di luhureunana: konci Commerce API kalawan scope anu jelas, pamicu webhook anu aman, jeung flow anu nelepon sistem anjeun.

Hiji kontrak OpenAPI Konci API kalawan scope Webhook anu diverifikasi HMAC
API & Webhook × ConnectWiz
Payload téh data, lain paréntah
Konci kalawan scope: maca katalog · nulis pesenan
Webhook → diverifikasi HMAC → flow dimimitian
Léngkah REST dina flow nelepon API anjeun
1
Kontrak OpenAPI anu jadi patokan — file anu sarua anu ngahasilkeun panel jeung aplikasi mobile kami sorangan
3
Scope Commerce — maca katalog, maca pesenan, nulis pesenan — dikaluarkeun per konci
100
Baris maksimal per bacaan, diwatesan di sisi server — paraméter limit divalidasi, moal dipercaya kitu waé
50
Item per pesenan ngaliwatan API — wates anu ditétélakeun, lain wates anu karék kapanggih

Pamekar

Naon anu dipigawéna — sacara persis

Hiji kontrak patokan

Hiji dokumén OpenAPI 3 nangtukeun platformna; klién TypeScript kami sorangan dihasilkeun tina dokumén éta — dokuméntasi moal bisa nyimpang tina kanyataan, sabab kanyataanana diwangun tina dokuméntasi.

Konci Commerce API

Konci anu dikaluarkeun ku tenant kalawan scope anu jelas — maca katalog, maca pesenan, nulis pesenan — ngajalankeun toko atawa aplikasi anjeun nyalira dina mesin pesenan anu sarua, kalawan harga anu salawasna ditangtukeun di sisi server.

Webhook asup, diamankeun

Unggal pamicu webhook flow boga URL jeung secret sorangan, verifikasi HMAC kana body atah, jeung panyalindungan replay. Payload bisa nyebut hiji jalma; tapi moal bisa ngatur jero flow.

Kaluar ngaliwatan flow

Léngkah REST nelepon sistem anjeun persis dina momen anu ku anjeun digambar dina kanvas — pesenan asup, idin dibikeun, réservasi dijieun.

Sisi téknis

Sikep desain API, ditétélakeun

Harga moal datang ti klién

Paménta pesenan ngan nyebutkeun naon jeung sabaraha — ngaran jeung harga dibaca tina katalog dina waktu éta, di sisi server, tuluy ditulis kana baris pesenan salaku snapshot. Paménta anu diotak-atik moal bisa nyieun diskon sorangan.

Kamampuh heula, karék nelepon

Unggal tempat integrasi ngumumkeun kontrak kamampuhna — naha bisa nyocogkeun ku nomer telepon, némbongkeun pesenan tanpa akun, nyieun pesenan? — sarta nelepon hal anu geus dinyatakeun "henteu" langsung ngaluarkeun kasalahan, lain gagal di hiji tempat anu jero.

Kasalahan anu aya hartina

Lapisan transport ngabédakeun "teu boga hak aksés" jeung "layanan keur pareum" — ku kituna "toko teu bisa dihubungi" moal pernah ditémbongkeun salaku "konsumén ieu can pernah meuli nanaon". Kasalahan anu dingaranan téh anu ngabédakeun API jeung kaulinan tatebakan.

Webhook anu tahan replay

Unggal event asup ngaku hiji konci unik dina catetan idempotency saméméh diolah — kiriman anu dicoba deui atawa diulang dieureunkeun di lapisan basis data, lain di otomatisasi anjeun.

Konci di-hash, secret dibatesan

Konci API disimpen dina wangun hash, sarta di lawang ngan hash jeung scope-na anu bisa dibaca — baris basis data anu bocor teu nyebut workspace mana waé sarta teu muka nanaon di luar scope-na.

Draf jeung konfirmasi téh eksplisit

Nyieun pesenan butuh paraméter confirm anu eksplisit — API publik sacara default dikonfirmasi, flow di panel bisa nyiapkeun draf — ku kituna "ieu téh nyata?" mangrupa hiji field, lain kabiasaan.

Pamasangan

Cara nyambungna

01

Damel konci

Damel konci Commerce API kalawan scope dina panel; cabut deui sami gampilna.

02

Pasang webhook

Damel flow kalawan pamicu webhook; tandatanganan paménta nganggo secret-na.

03

Hubungi deui sistem anjeun

Tambihan léngkah REST di tempat sistem anjeun peryogi terang kajadianana.

Leuwih hadé babarengan

Naon anu bisa dipadukeun

Flows

Pamicu webhook ngamimitian flow; léngkah REST nelepon deui sistem anjeun dina momen anu ku anjeun digambar — otomatisasi asup jeung kaluar babagi hiji kanvas.

Commerce

Ari mesin katalog jeung pesenan di tukangeun API mah sarua jeung anu dipaké ku toko dina chat jeung AI — hiji data pesenan, opat panto.

Toko anjeun nyalira

Ayeuna tim-tim ngajalankeun toko headless dina Commerce API — jalur anu disarankeun sacara jujur ku kaca Shopify salila konektor asli keur diwangun.

Kaamanan & jaminan

Jaminan anu ngabosenkeun

HMAC kana body atah

Verifikasi webhook nandatanganan body paménta anu atah ku secret per pamicu tuluy ngabandingkeunana dina waktu konstan — parsing karék dilakukeun sanggeus kabuktian.

Payload téh data, lain paréntah

Payload webhook bisa nuduhkeun hiji jalma; tapi moal bisa ngatur jero flow, nulis ulang prompt atawa ngajalankeun parabot. Wates antara data jeung paréntah téh aya dina arsitékturna, lain dina paripolahna.

Wates laju di unggal lawang

Endpoint publik ngagunakeun throttling standar, sarta wates bacaan diwatesan di sisi server — klién anu ngaco ngan ngarugikeun dirina sorangan, lain platformna.

Katangtuan rinci, satarabasna

Wates, ditétélakeun

Can aya firehose

Feed webhook umum anu ngalanggan sakabéh event can diwangun — ayeuna event kaluar lumangsung ngaliwatan léngkah flow. Ditétélakeun di dieu, sangkan teu aya obrolan jualan anu kudu nyindiran sabalikna.

Bacaan diwatesan, ngahaja kitu

Bacaan mulangkeun nepi ka 100 baris kalawan cursor — API ieu diwangun pikeun integrasi operasional, lain ékspor massal. Kabutuh massal mah kudu diobrolkeun, lain diakalan.

FAQ API & Webhook

Jawaban anu lugas

Katerangan anu langkung jangkep aya dina FAQ, atanapi mangga taroskeun langsung ka kami.

Platformna ditetepkeun dina hiji kontrak OpenAPI 3 — file anu sarua anu dipaké ku panel wéb jeung aplikasi mobile kami pikeun ngahasilkeun tipe-tipena. Naon anu diintegrasikeun ku anjeun téh sarua jeung anu dipaké ku kami.

Secret per pamicu, verifikasi HMAC kana body atah, jeung panyalindungan replay ngaliwatan catetan idempotency. Sarta numutkeun aturan, payload téh data: bisa nuduhkeun hiji jalma, tapi moal bisa maréntah otomatisasi.

Ngaliwatan léngkah REST dina flow, anu dijalankeun dina momen anu ku anjeun dipilih dina kanvas. Feed webhook kaluar anu umum aya dina rencana ka hareup sarta ngahaja teu dijangjikeun nepi ka dirilis.

Tiasa — maca katalog sareng nulis pesenan téh jalur anu dirojong, kalawan harga anu ditangtukeun di sisi server sareng konci kalawan scope anu tiasa anjeun cabut per tempat. Wates 50 item pesenan sareng 100 baris bacaan ditétélakeun supados anjeun tiasa ngarancang dumasar kana wates éta, sanés kasandung ku éta.

Kiriman di sisi kami sipatna idempotent — catetanana ngawanoh replay tuluy ngalungsurkeunana, ku kituna sistem anjeun bisa nyoba deui kalawan aman. Léngkah REST kaluar tina flow boga kawijakan nyoba deui sorangan, sarta kagagalanana ditémbongkeun dina catetan jalanna flow.

Nyambung sacara jujur leuwih hadé tibatan nyambung bari gandéng.

Unggal integrasi di dieu dipedar dumasar kana naon anu saéstuna dipigawéna — kaasup arah, kapamilikan, jeung watesna.