BTS API Docs

Konfiguratsiya

GET /v1/webhook/webhook-config

Ushbu bo‘lim orqali webhook sozlamalari olinadi yoki boshqariladi.

Webhook — bu tizimda muhim hodisalar sodir bo‘lganda (masalan, buyurtma statusi o‘zgarganda) tashqi tizimga avtomatik ravishda xabar yuborish mexanizmi.

Ushbu endpoint orqali webhook manzili (URL), faol holati va boshqa tegishli sozlamalar bilan ishlash mumkin. Bu integratsiya tashqi tizimlarga buyurtma holatlari yoki boshqa voqealar haqida real vaqt rejimida ma’lumot uzatish uchun ishlatiladi.

Bu endpoint webhook konfiguratsiyasini boshqarish uchun mo‘ljallangan va buyurtma ma’lumotlarini o‘zgartirmaydi.

Kiritilgan endpointga quyidagi so'rov yuboriladi:

curl --location '{{url}}' \
--form 'text="{\"clientId\":null,\"orderId\":1234567,\"barcode\":\"01011234567\",\"status\":{\"id\":6,\"name\":\"Доставлен"},\"date\":\"2022-06-20 07:55:01\"}"'

API Server


                    https://apitest.bts.uz:28345/

Base Path


                    /v1/webhook/webhook-config

Full URL


                        https://apitest.bts.uz:28345/v1/webhook/webhook-config

Authentication Bearer Token

Headers

Header

Value

Req.

Authorization

Bearer {token}

🔒

Content-Type

application/json

🔒

application/json

🔒

language

uz

🔒

{
    "webhook_url": "https://test.uz",
    "environment": "production",
    "has_token": true,
    "itx-apiKey": ""
}

Field	Type	Description
`webhook_url` *	string	POST (form-data) orqali ma'lumotlarni qabul qiladigan ochiq link
`environment` *	enum	Muvofiqlik muhiti, qiymat ENUM tarzda keladi: production, test
`has_token`	boolean	Har bir webhook so'rovida token yuborish
`itx-apiKey`	string	ITX API kaliti

RESPONSE

Example
Schema

HTTP 200

Response Body

{
    "status": true,
    "message": "Muvaffaqiyatli yaratildi.",
    "status_code": 200,
    "data": {
        "webhook_url": "https://test.uz",
        "method": "POST",
        "date": "2026-01-08",
        "has_token": true,
        "environment": "production",
        "itx-apiKey": ""
    }
}

Field	Type	Description
`webhook_url`	string	POST (form-data) orqali ma'lumotlarni qabul qiladigan ochiq link
`method`	string	Method nomi, doimiy POST bo'ladi
`date`	string	Ma'lumot kiritilgan sana
`has_token`	boolean	Har bir webhook so'rovida token yuborish
`itx-apiKey`	string	ITX API kaliti

Example
Schema

HTTP 422

Response Body

{
    "status": false,
    "message": "Tekshiruv xatosi.",
    "status_code": 422,
    "errors": {
        "webhook_url": [
            "URL notog‘ri"
        ],
        "environment": [
            "Notog‘ri environment"
        ]
    }
}

No schema defined.