ConnectWiz + API & Webhook

Integrasi aktif

API yang kami jual ialah API yang kami gunakan

Seluruh platform ditentukan dalam satu kontrak OpenAPI yang menjana panel dan aplikasi mudah alih kami sendiri — tiada endpoint tersembunyi, tiada dokumentasi yang tersasar. Di atasnya: kunci Commerce API berskop, pencetus webhook yang dilindungi, dan aliran yang memanggil sistem anda.

Satu kontrak OpenAPI Kunci API berskop Webhook disahkan HMAC
API & Webhook × ConnectWiz
Payload ialah data, bukan arahan
Kunci berskop: baca katalog · tulis pesanan
Webhook → HMAC disahkan → aliran bermula
Langkah REST aliran memanggil API anda
1
Kontrak OpenAPI rasmi — fail yang sama yang menjana panel dan aplikasi mudah alih kami sendiri
3
Skop Commerce — baca katalog, baca pesanan, tulis pesanan — dikeluarkan bagi setiap kunci
100
Baris maksimum setiap bacaan, dihadkan di pihak pelayan — parameter had disahkan, tidak sekali-kali dipercayai begitu sahaja
50
Item baris setiap pesanan melalui API — had yang dinyatakan, bukan yang ditemui secara tidak sengaja

Pembangun

Apa yang dilakukannya — dengan tepat

Satu kontrak rasmi

Satu dokumen OpenAPI 3 menentukan platform ini; klien TypeScript kami sendiri dijana daripadanya — dokumentasi tidak boleh tersasar daripada realiti kerana realiti dibina daripada dokumentasi.

Kunci Commerce API

Kunci yang dikeluarkan oleh tenant dengan skop yang jelas — baca katalog, baca pesanan, tulis pesanan — menggerakkan kedai atau aplikasi anda sendiri di atas enjin pesanan yang sama, dengan harga sentiasa ditentukan di pihak pelayan.

Webhook masuk, dilindungi

Setiap pencetus webhook aliran mempunyai URL dan rahsianya sendiri, pengesahan HMAC ke atas badan mentah dan perlindungan main semula. Payload boleh menamakan seseorang; ia tidak sekali-kali boleh mengemudi bahagian dalaman aliran.

Keluar melalui aliran

Langkah REST memanggil sistem anda tepat pada saat yang anda lukis di kanvas — pesanan dibuat, persetujuan diberi, tempahan dibuat.

Dari sudut teknikal

Pendirian reka bentuk API, dinyatakan dengan jelas

Harga tidak pernah datang daripada klien

Permintaan pesanan hanya menyatakan apa dan berapa banyak — nama dan harga dibaca daripada katalog pada saat itu, di pihak pelayan, lalu ditulis pada baris pesanan sebagai petikan. Permintaan yang diusik tidak boleh mencipta diskaun.

Keupayaan sebelum panggilan

Setiap tempat paparan integrasi menerbitkan kontrak keupayaan — bolehkah ia memadankan melalui nombor telefon, menyenaraikan pesanan tetamu, mencipta pesanan? — dan panggilan yang melepasi "tidak" yang telah diisytiharkan terus membuang ralat, bukannya gagal di suatu tempat yang jauh di dalam.

Ralat yang bermakna

Lapisan pengangkutan membezakan "tidak dibenarkan" daripada "perkhidmatan terputus" — jadi "kedai tidak dapat dihubungi" tidak pernah dipaparkan sebagai "pelanggan ini tidak pernah membeli apa-apa". Ralat yang bernama itulah bezanya antara API dengan permainan teka-teki.

Webhook kalis main semula

Setiap peristiwa masuk menuntut kunci unik dalam lejar idempotensi sebelum diproses — penghantaran yang dicuba semula atau dimainkan semula terhenti di lapisan pangkalan data, bukan dalam automasi anda.

Kunci dicincang, rahsia berskop

Kunci API disimpan sebagai cincangan, dan hanya cincangan serta skopnya boleh diselesaikan di pintu masuk — baris pangkalan data yang bocor tidak menamakan sebarang ruang kerja dan tidak membuka apa-apa di luar skopnya.

Draf dan pengesahan dinyatakan secara jelas

Penciptaan pesanan menerima parameter pengesahan yang jelas — API awam secara lalai menganggapnya disahkan, aliran panel boleh menyediakan draf dahulu — jadi "adakah ini betul-betul?" ialah satu medan, bukan sekadar kebiasaan.

Persediaan

Cara ia bersambung

01

Keluarkan kunci

Cipta kunci Commerce API berskop dalam panel; batalkannya semudah itu juga.

02

Sambungkan webhook

Cipta aliran dengan pencetus webhook; tandatangani permintaan dengan rahsianya.

03

Panggil sistem anda

Tambah langkah REST pada titik sistem anda perlu dimaklumkan.

Lebih baik bersama

Apa yang boleh digabungkan

Flows

Pencetus webhook memulakan aliran; langkah REST memanggil semula sistem anda pada saat yang anda lukis — automasi masuk dan keluar berkongsi satu kanvas.

Commerce

Di sebalik API ini terletak enjin katalog dan pesanan yang sama digunakan oleh kedai dalam sembang dan AI — satu sumber kebenaran pesanan, empat pintu masuk.

Kedai anda sendiri

Pasukan kini sudah menjalankan kedai headless di atas Commerce API — laluan yang disyorkan secara jujur oleh halaman Shopify sementara penyambung asli sedang dibina.

Keselamatan & jaminan

Jaminan yang membosankan

HMAC ke atas badan mentah

Pengesahan webhook menandatangani badan permintaan mentah dengan rahsia khusus bagi setiap pencetus dan membandingkannya dalam masa malar — penghuraian hanya berlaku selepas terbukti sah.

Payload ialah data, bukan arahan

Payload webhook boleh merujuk seseorang; ia tidak sekali-kali boleh mengemudi bahagian dalaman aliran, menulis semula prompt atau memanggil alat. Sempadan antara data dengan arahan terletak pada seni bina, bukan pada tingkah laku.

Had kadar di setiap pintu

Endpoint awam tertakluk pada pendikitan standard, dan had bacaan dikunci di pihak pelayan — klien yang berkelakuan buruk hanya menjejaskan dirinya sendiri, bukan platform.

Syarat terperinci, tanpa selindung

Had, dinyatakan dengan jelas

Belum ada suapan semua peristiwa

Suapan webhook generik yang melanggan semua peristiwa belum dibina — buat masa ini peristiwa keluar berlaku melalui langkah aliran. Dinyatakan di sini supaya tiada panggilan jualan perlu membayangkan sebaliknya.

Bacaan berhad, dengan sengaja

Bacaan memulangkan sehingga 100 baris dengan kursor — API ini dibina untuk integrasi operasi, bukan eksport pukal. Keperluan pukal dibincangkan bersama, bukan dicari celahnya.

Soalan Lazim API & Webhook

Jawapan terus

Selebihnya di halaman Soalan Lazim, atau tanya kami terus.

Platform ini ditentukan dalam satu kontrak OpenAPI 3 — fail yang sama yang menjana jenis data untuk panel web dan aplikasi mudah alih kami. Apa yang anda integrasikan ialah apa yang kami jalankan.

Rahsia khusus bagi setiap pencetus, pengesahan HMAC ke atas badan mentah, dan perlindungan main semula melalui lejar idempotensi. Dan sebagai peraturan, payload ialah data: ia boleh merujuk seseorang, tetapi tidak sekali-kali mengarahkan automasi.

Melalui langkah REST dalam aliran, yang dicetuskan pada saat yang anda pilih di kanvas. Suapan webhook keluar yang generik ada dalam pelan hala tuju dan sengaja tidak dijanjikan sehingga benar-benar dilancarkan.

Boleh — bacaan katalog dan penulisan pesanan ialah laluan yang disokong, dengan harga ditentukan di pihak pelayan dan kunci berskop yang boleh anda batalkan bagi setiap tempat paparan. Had 50 baris pesanan dan 100 baris bacaan dinyatakan supaya anda mereka bentuk mengikutnya, bukan tersandung padanya.

Penghantaran bersifat idempoten di pihak kami — lejar mengenali main semula dan membuangnya, jadi sistem anda boleh mencuba semula dengan selamat. Langkah REST keluar daripada aliran mempunyai dasar cubaan semula tersendiri, dan kegagalan dipaparkan pada larian aliran.

Bersambung dengan jujur lebih baik daripada bersambung dengan bising.

Setiap integrasi di sini diterangkan mengikut apa yang benar-benar dilakukannya — termasuk arah, pemilikan dan hadnya.