Dasturchilar uchun
API va webhook
1C, o‘z Telegram botingiz, hisob dasturi yoki marketpleysni do‘koningizga ulang: tovar va buyurtmalarni o‘qing, narxni yangilang, tashqaridan buyurtma qabul qiling.
Boshlash
- Do‘kon tarifida «API ulanish» moduli bo‘lsin.
- Panelda Tarif → API ulanish bo‘limida kalit yarating: faqat o‘qish yoki o‘qish va yozish.
- Kalit faqat bir marta ko‘rsatiladi — uni xavfsiz joyda saqlang. Kerak bo‘lmasa — o‘sha yerda bekor qiling.
Asosiy manzil: https://developers.vobecom.uz/api/v1
Kalit va sarlavhalar
Har so‘rovda kalitni Authorization sarlavhasida yuboring (yoki X-Api-Key). Javob tili — Accept-Language yoki x-vbc-til: uz, ru, en.
curl https://developers.vobecom.uz/api/v1/buyurtmalar?holat=yangi \
-H "Authorization: Bearer vbk_…"Javob va xatolar
Muvaffaqiyatli javob — {"malumot": …}. Xato — {"xato": {"kod", "matn"}}. Ro‘yxatlarda limit (sukut 50, ko‘pi bilan 200) va offset. Har javobda X-Request-Id sarlavhasi bor (o‘zingiz yuborsangiz — o‘sha qaytadi): yordam so‘raganda shuni ayting. POST /buyurtmalar ga Idempotency-Key sarlavhasini (8–128 belgi) yuboring: javob yo‘qolib so‘rovni qayta yuborsangiz, ikkinchi buyurtma yaratilmaydi — o‘sha buyurtma qaytadi (Idempotent-Replayed: true). Kalit 24 soat saqlanadi.
| Kod | HTTP | Ma’nosi |
|---|---|---|
kalit | 401 | Kalit yo‘q, noto‘g‘ri yoki bekor qilingan |
tarif | 402 | Tarifda «API ulanish» moduli yo‘q |
huquq | 403 | Kalit faqat o‘qish uchun |
parametr | 400 | Parametr yoki tana noto‘g‘ri |
topilmadi | 404 | Tovar yoki buyurtma topilmadi |
kop-urinish | 429 | Bir raqamdan bugun juda ko‘p buyurtma |
chegara | 429 | Juda ko‘p so‘rov: bitta kalit daqiqasiga 120 tagacha. Retry-After sarlavhasidagi soniyadan keyin qayta yuboring |
idempotency | 409 / 422 | 409 — shu Idempotency-Key bilan so‘rov hali bajarilmoqda (Retry-After); 422 — kalit boshqa tarkibli so‘rov bilan ishlatilgan |
ichki | 500 | Kutilmagan xatolik — keyinroq qayta urining |
Tovarlar
| Usul | Yo‘l | Tavsif |
|---|---|---|
| GET | /tovarlar | Ro‘yxat. ?kategoriya=kalit&limit=&offset= |
| GET | /tovarlar/{kalit} | Bitta tovar |
| PATCH | /tovarlar/{kalit} | narx, eski_narx, faol, tavsif. Qoldiq bu yerda o‘zgarmaydi — ombor orqali. |
Tovar maydonlari: kalit, nom, narx, eski_narx, qoldiq, faol, rasmlar, tavsif, kategoriya, yaratilgan, variantlar [kalit, nom, qiymatlar, narx, qoldiq, faol].
Kategoriyalar
| Usul | Yo‘l | Tavsif |
|---|---|---|
| GET | /kategoriyalar | Ro‘yxat: kalit, nom, rasm |
Buyurtmalar
| Usul | Yo‘l | Tavsif |
|---|---|---|
| GET | /buyurtmalar | ?holat=&dan=ISO-sana&limit=&offset= |
| GET | /buyurtmalar/{raqam} | Bitta buyurtma |
| POST | /buyurtmalar | Tashqi kanaldan yangi buyurtma. Narx, chegirma va yetkazishni platforma hisoblaydi. |
holat qiymatlari: yangi, jarayonda, tasdiqlandi, kuryerda, sotildi, bekor, qaytarildi
POST tanasi: ism, telefon (9 raqam), viloyat?, tuman?, manzil?, izoh?, qatorlar: 1–50 ta [{kalit, soni 1–1000}]. Javob 201: raqam, tovar_summa, yetkazish, jami.
curl -X POST https://developers.vobecom.uz/api/v1/buyurtmalar \
-H "Authorization: Bearer vbk_…" -H "Content-Type: application/json" \
-d '{"ism":"Aziz","telefon":"901234567","viloyat":"Toshkent",
"qatorlar":[{"kalit":"kreslo-oqshom","soni":1}]}'{
"malumot": { "raqam": "00042", "tovar_summa": 1450000,
"yetkazish": 30000, "jami": 1480000 }
}Mijozlar
| Usul | Yo‘l | Tavsif |
|---|---|---|
| GET | /mijozlar | ?q=telefon yoki ism&limit=&offset=. Maydonlar: telefon, ism, viloyat, tuman, manzil, buyurtmalar, olgan, voz_kechgan, jami_summa, bonus, birinchi, oxirgi |
Ombor (qoldiq sinxroni)
| Usul | Yo‘l | Tavsif |
|---|---|---|
| GET | /ombor | Har sotiladigan birlik (variantlar alohida): kalit, nom, ota_kalit, qoldiq, min_qoldiq, shtrix, faol. ?limit= (500 gacha)&offset= |
| PATCH | /ombor | Qoldiqni o‘rnatish: {"qatorlar": [{"kalit", "qoldiq"}]} — 500 tagacha. Ombor tarixiga «sanoq · API» bo‘lib yoziladi. |
1C yoki MoySklad bilan sinxron: hisob dasturi har N daqiqada PATCH /ombor yuboradi, do‘kondagi sotuvlarni esa stock.changed webhooki orqali oladi. Javob: yangilandi, topilmadi, notogri. Ko‘p qator bir vaqtda o‘zgarsa, webhookda «To‘plab yuborish»ni yoqing: hodisalar bitta so‘rovda 100 tagacha keladi — { "hodisa": "batch", "soni": n, "hodisalar": [oddiy webhook tanalari] }, sarlavha x-vbc-hodisa: batch.
curl -X PATCH https://developers.vobecom.uz/api/v1/ombor \
-H "Authorization: Bearer vbk_…" -H "Content-Type: application/json" \
-d '{"qatorlar": [{"kalit": "A1", "qoldiq": 12}, {"kalit": "B7", "qoldiq": 0}]}'Webhooklar
Panelda Tarif → Webhooklar bo‘limida https manzil qo‘shing va hodisalarni tanlang. Har hodisa — POST, JSON tana: hodisa, vaqt, dokon va hodisaga qarab buyurtma, tovar yoki mijoz (/api/v1 bilan bir xil ko‘rinish).
order.created | Buyurtma yaratildi (qaysi kanaldan bo‘lmasin) |
|---|---|
order.status_changed | Holat o‘zgardi: + oldingi_holat, yangi_holat |
order.paid | To‘landi |
product.created | Tovar qo‘shildi: + tovar |
product.updated | Tovar o‘zgardi: + tovar, ozgargan (maydonlar ro‘yxati) |
product.archived | Tovar o‘chirildi (arxiv) |
stock.changed | Qoldiq o‘zgardi: + oldingi, yangi, farq, sabab (sotuv, kirim, sanoq, qaytish, kassa…) |
stock.low | Qoldiq min_qoldiq chegarasiga tushdi: + qoldiq, chegara, tugadi |
customer.created | Yangi mijoz: + mijoz |
ping | Paneldagi «Sinov xabari» |
Sarlavhalar
x-vbc-hodisaorder.* | product.* | stock.changed | stock.low | customer.created | ping | batchx-vbc-yetkazishidx-vbc-vaqtunixx-vbc-imzosha256=<hex>user-agentVOBECOM-Webhook/1.0
Imzoni tekshirish: xom tana bo‘yicha HMAC-SHA256(sir, vaqt + "." + tana) ni hisoblang, x-vbc-imzo bilan doimiy vaqtli solishtiring, 5 daqiqadan eski vaqtni rad eting. Takrorni x-vbc-yetkazish bo‘yicha tashlang.
import { createHmac, timingSafeEqual } from 'node:crypto';
function tekshir(xomTana, sarlavha, sir) {
const vaqt = sarlavha['x-vbc-vaqt'];
if (Math.abs(Date.now() / 1000 - Number(vaqt)) > 300) return false;
const kutilgan = 'sha256=' + createHmac('sha256', sir)
.update(vaqt + '.' + xomTana).digest('hex');
const a = Buffer.from(kutilgan), b = Buffer.from(sarlavha['x-vbc-imzo'] ?? '');
return a.length === b.length && timingSafeEqual(a, b);
}2xx javob — yetkazildi. Boshqa javob yoki 10 soniyada javob bo‘lmasa — qayta urinish: 1, 5, 15 daqiqa, 1, 3, 6, 12 soat (jami 8 marta).
Qaysi tizimlar bilan ulanadi
Quyidagi tizimlar VOBECOM bilan ishlaydi. «Ichki» — panelda bir tugma bilan ulanadi; «API/webhook» — shu hujjatdagi API va webhooklar orqali (dasturchi yoki Make/Zapier/n8n kabi ulagich bilan).
| Tizim | Ulanish | Nima beradi |
|---|---|---|
| Payme, Click, Uzum Bank, Paynet | Ichki | Onlayn to‘lov — Integratsiyalar → To‘lov |
| Telegram | Ichki | Do‘kon boti, Mini App, xabarlar konstruktori |
| Yandex Yetkazish, BTS, EMU | Ichki | Yetkazish xizmatlari, trek raqam |
| Meta Pixel, Google Analytics 4, Google Ads, Yandex Metrika | Ichki | Piksellar va server konversiyalar |
| OFD (fiskal chek), SMS | Ichki | Fiskal chek va SMS xabarlar |
| 1C:Korxona, MoySklad | API/webhook | order.created → hisobga buyurtma; PATCH /ombor ← qoldiq; product.* → katalog |
| amoCRM, Bitrix24 | API/webhook | order.created va customer.created → bitim va kontakt |
| Google Sheets, Airtable | API/webhook | Make/Zapier/n8n orqali har buyurtma yoki qoldiq o‘zgarishi jadvalga |
| Make, Zapier, n8n | API/webhook | Har qanday hodisadan istalgan xizmatga — kodsiz |
| O‘z ilovangiz yoki saytingiz | API/webhook | Tovarlar, buyurtma qabul qilish, holatlar |