ConnectWiz + API ба webhook

Ажиллаж буй интеграц

Бидний зардаг API бол бидний ашигладаг API

Платформ бүхэлдээ нэг OpenAPI тодорхойлолтод бичигдсэн бөгөөд манай самбар, мобайл апп хоёр түүнээс үүсгэгддэг — далд endpoint ч, баримт бичгээс зөрсөн зүйл ч байхгүй. Үүн дээр нэмээд: эрх нь заагдсан Commerce API түлхүүр, хамгаалалттай webhook trigger, танай систем рүү хандах flow.

Нэг OpenAPI тодорхойлолт Эрх заасан API түлхүүр HMAC-аар шалгасан webhook
API ба webhook × ConnectWiz
Payload бол өгөгдөл, хэзээ ч тушаал биш
Эрхтэй түлхүүр: каталог унших · захиалга бичих
Webhook → HMAC шалгагдсан → flow эхэлнэ
Flow дахь REST алхам танай API-г дуудна
1
Үндсэн OpenAPI тодорхойлолт — манай самбар, мобайл апп яг энэ файлаас үүсгэгддэг
3
Commerce эрх — каталог унших, захиалга унших, захиалга бичих — түлхүүр тус бүрд олгоно
100
Нэг уншилтад буцах дээд мөр, сервер талд хязгаарлагдана — limit параметрийг шалгадаг, сохроор итгэдэггүй
50
API-аар нэг захиалгад орох барааны мөр — санамсаргүй олдсон биш, урьдчилан заасан хязгаар

Хөгжүүлэгчид

Яг юу хийдэг вэ

Нэг үндсэн тодорхойлолт

Платформыг ганц OpenAPI 3 баримт тодорхойлдог бөгөөд манай өөрийн TypeScript клиентүүд түүнээс үүсгэгддэг — бодит байдал нь баримт бичгээсээ бүтдэг тул баримт бичиг бодит байдлаас зөрөх боломжгүй.

Commerce API түлхүүр

Tenant өөрөө олгодог, эрх нь тодорхой заагдсан түлхүүрүүд — каталог унших, захиалга унших, захиалга бичих — танай өөрийн дэлгүүр эсвэл аппыг ижил захиалгын хөдөлгүүр дээр ажиллуулна; үнийг үргэлж сервер тал тодорхойлно.

Хамгаалалттай ирэх webhook

Flow бүрийн webhook trigger өөрийн URL, нууц түлхүүртэй бөгөөд түүхий агуулга дээр HMAC шалгалт хийж, давтан илгээлтээс хамгаалдаг. Payload хүнийг нэрлэж болно, харин flow дотоод ажиллагааг хэзээ ч жолоодож чадахгүй.

Гарах холболт flow дотроос

REST алхам танай системийг яг самбар дээр зурсан мөчүүдэд тань дуудна — захиалга өгөгдсөн, зөвшөөрөл олгосон, цаг захиалсан үед.

Техникийн тал

API-ийн зохиомжийн зарчмыг тодорхой заасан

Үнэ хэзээ ч клиентээс ирдэггүй

Захиалгын хүсэлт юуг, хэдийг гэдгийг л хэлнэ — нэр, үнийг тухайн мөчид сервер тал каталогоос уншиж, мөрөнд агшин зуурын хуулбар болгон бичдэг. Хуурамчаар өөрчилсөн хүсэлт хөнгөлөлт зохиож чадахгүй.

Дуудахаас өмнө чадамж

Интеграцын орц бүр чадамжийн тодорхойлолтоо нийтэлдэг — утасны дугаараар тааруулж чадах уу, зочны захиалгыг жагсааж чадах уу, захиалга үүсгэж чадах уу? — “үгүй” гэж зарласныг үл тоон дуудвал хаа нэгтээ гүнд эвдрэхийн оронд тэр дор нь алдаа өгнө.

Утгатай алдаа

Дамжуулах давхарга “эрхгүй”, “үйлчилгээ унасан” хоёрыг ялгадаг — тиймээс “дэлгүүрт холбогдож чадсангүй” гэдэг хэзээ ч “энэ харилцагч юу ч худалдаж аваагүй” болж харагдахгүй. Нэртэй алдаа л API-г таавар тоглоомоос ялгадаг.

Давтан илгээлтэд тэсвэртэй webhook

Ирсэн үйл явдал бүр боловсруулагдахаасаа өмнө idempotency бүртгэлд давтагдашгүй түлхүүр эзэмшдэг — дахин оролдсон эсвэл давтан илгээсэн хүргэлт танай автоматжуулалтад биш, өгөгдлийн сангийн түвшинд зогсоно.

Түлхүүр hash хэлбэрээр, нууц эрхийн хүрээндээ

API түлхүүрийг hash хэлбэрээр хадгалж, хаалган дээр зөвхөн hash болон эрхийг нь тодорхойлдог — өгөгдлийн сангийн мөр задарсан ч ямар ч ажлын орчныг нэрлэхгүй, эрхээсээ цааш юуг ч нээхгүй.

Ноорог ба баталгаажуулалт тодорхой

Захиалга үүсгэхэд тодорхой confirm параметр авдаг — нийтийн API анхнаасаа баталгаажсан гэж үзэж, самбарын flow ноорог бэлтгэж болно — тиймээс “энэ бодит уу?” гэдэг нь тохиролцоо биш, талбар.

Тохиргоо

Хэрхэн холбогддог вэ

01

Түлхүүр олгох

Самбарт эрх заасан Commerce API түлхүүр үүсгээрэй; яг л амархан цуцална.

02

Webhook холбох

Webhook trigger-тэй flow үүсгээд, хүсэлтүүдээ түүний нууц түлхүүрээр гарын үсэг зураарай.

03

Буцаан дуудах

Танай систем мэдэх ёстой газарт REST алхам нэмээрэй.

Хослуулж ашиглах

Юутай хослуулж болох вэ

Flows

Webhook trigger-ээр flow эхэлнэ; REST алхамууд таны зурсан мөчүүдэд танай системийг буцаан дуудна — ирэх, гарах автоматжуулалт нэг самбарыг хуваалцана.

Commerce

Манай каталог ба захиалгын хөдөлгүүр API-ийн ард ч, чат дэлгүүр болон AI-ийн ард ч нэг л — захиалгын нэг үнэн, дөрвөн хаалга.

Өөрийн дэлгүүр

Багууд өнөөдөр Commerce API дээр headless дэлгүүрээ ажиллуулж байна — төрөлх холбогч бүтээгдэж байх хооронд энэ замыг Shopify хуудас шударгаар санал болгодог.

Аюулгүй байдал ба баталгаа

Уйтгартай баталгаа

Түүхий агуулга дээрх HMAC

Webhook-ийн шалгалт хүсэлтийн түүхий агуулгыг trigger тус бүрийн нууц түлхүүрээр гарын үсэглэж, тогтмол хугацаанд харьцуулдаг — задлан уншилт зөвхөн нотолгооны дараа хийгдэнэ.

Payload бол өгөгдөл, хэзээ ч тушаал биш

Webhook payload хүнийг заах боломжтой, харин flow дотоод ажиллагааг жолоодох, prompt дахин бичих, хэрэгсэл дуудах боломжгүй. Өгөгдөл ба зааврын хоорондох хил нь зан төлөвт бус, архитектурт суурилдаг.

Хаалга бүрт хурдны хязгаар

Нийтийн endpoint бүр стандарт хязгаарлалттай ажиллаж, уншилтын хязгаарыг сервер тал тогтоодог — буруу ажилласан клиент платформыг биш, өөрийгөө л удаашруулна.

Нууц заалтгүй нөхцөл

Хязгаарыг тодорхой заасан

Бүх үйл явдлын урсгал одоохондоо алга

Бүх зүйлд бүртгүүлдэг ерөнхий webhook урсгал бүтээгдээгүй — өнөөдөр гарах үйл явдлууд flow дахь алхмаар дамждаг. Борлуулалтын ямар ч яриа өөрөөр ойлгуулах шаардлагагүйн тулд энд тодорхой бичлээ.

Санаатайгаар хязгаарласан уншилт

Уншилт cursor ашиглан хуудаслаж, 100 хүртэл мөр буцаана — API нь бөөн экспортод биш, өдөр тутмын интеграцад зориулагдсан. Бөөн хэрэгцээ бол цоорхой биш, бидэнтэй ярилцах сэдэв.

API ба webhook: түгээмэл асуулт

Шууд хариулт

Илүү дэлгэрэнгүйг Түгээмэл асуулт хэсгээс үзээрэй, эсвэл бидэнд шууд бичээрэй.

Платформыг нэг OpenAPI 3 тодорхойлолт тодорхойлдог — манай вэб самбар, мобайл апп төрлүүдээ яг энэ файлаас үүсгэдэг. Таны интеграц хийж буй зүйл дээр бид өөрсдөө ажилладаг.

Trigger тус бүрийн нууц түлхүүр, түүхий агуулга дээрх HMAC шалгалт, idempotency бүртгэлээр давтан илгээлтээс хамгаалах. Мөн дүрмээр payload бол өгөгдөл: хүнийг заах боломжтой ч автоматжуулалтад хэзээ ч тушаал өгөхгүй.

Flow дахь REST алхмаар, самбар дээр таны сонгосон мөчүүдэд. Ерөнхий гарах webhook урсгал хөгжүүлэлтийн төлөвлөгөөнд байгаа бөгөөд гарах хүртэл нь санаатайгаар амлаагүй.

Тийм — каталог унших, захиалга бичих нь дэмжигдсэн зам бөгөөд үнийг сервер тал тодорхойлж, орц тус бүрээр цуцалж болох эрхтэй түлхүүр ашиглана. 50 мөр, 100 мөрийн хязгаарыг урьдчилан заасан тул та түүнд бүдрэхийн оронд тооцоолж зохиох боломжтой.

Хүргэлт манай талд idempotent — бүртгэл давтан илгээлтийг таньж хасдаг тул танай систем аюулгүй дахин оролдож болно. Flow дотроос гарах REST алхамууд өөрийн дахин оролдох бодлоготой бөгөөд алдаа нь flow ажиллалт дээр харагдана.

Шуугиантай холболтоос шударга холболт дээр.

Энд байгаа интеграц бүрийг бодитоор юу хийдгээр нь тайлбарласан — чиглэл, эзэмшил, хязгаарыг нь оруулаад.