Postman va Insomnia to'plamlari

To’plam integratsiya kaliti uchun mavjud bo’lgan barcha metodlarni o’z ichiga oladi, ular kalit marshrutlari ro’yxati bilan bir xil bo’limlarga guruhlangan. Avtorizatsiya Bearer {{access_token}} ga sozlangan, server manzili baseUrl o’zgaruvchisiga o’tkazilgan. Asinxron metodlar uchun Billz-Response-Channel: HTTP sarlavhasi allaqachon qo’yilgan. Odatiy qiymatga ega bo’lmagan ixtiyoriy sarlavhalar, masalan, accept-language, o’chirilgan: agar kerak bo’lsa, ularni yoqing va qiymat kiriting.

Fayl: billz-api.postman_collection.json (Postman Collection v2.1 formati, Postman va Insomnia da o’qiladi).

O’zgaruvchilar

O’zgaruvchi	Qiymat
baseUrl	https://api-admin.billz.ai
secret_token	integratsiya kaliti — qo’lda to’ldirilishi kerak bo’lgan yagona o’zgaruvchi
access_token	Kirish tokenini olish so’rovi bilan avtomatik ravishda to’ldiriladi
refresh_token	avtomatik ravishda to’ldiriladi, Kirish tokenini yangilash so’rovi orqali ishlatiladi

Tokenni qanday olish mumkin

1. secret_token o’zgaruvchisini integratsiya kaliti bilan to’ldiring.
2. «Autentifikatsiya» bo’limida Kirish tokenini olish (POST /v1/auth/login) amalini bajaring. So’rov skripti javobdan access_token va refresh_token ni to’plam o’zgaruvchilariga saqlaydi.
3. Shundan so’ng to’plamning barcha so’rovlari avtorizatsiya qilinadi. access_token muddati tugagach, Kirish tokenini yangilash (POST /v2/auth/refresh) amalini bajaring: so’rov tanasi o’zgaruvchidan refresh_token ni oladi, skript ikkala o’zgaruvchini ham yangilaydi.

Toki access_token bo’sh ekan, so’rovlar Authorization sarlavhasiz yuboriladi va API 401 UNAUTHORIZED deb javob beradi.

Postman

1. Import → Upload Files orqali to’plam faylini tanlang.
2. To’plamni oching → Variables varag’iga o’ting → secret_token o’zgaruvchisining Current value qismini to’ldiring. baseUrl zarurat tug’ilganda o’sha yerda o’zgartiriladi.
3. Kirish tokenini olish amalini bajaring — tokenlar Current valueda paydo bo’ladi.

Insomnia

1. Import → From File orqali xuddi shu faylni tanlang. Insomnia Postman formatini, shu jumladan so’rov skriptlarini ham taniy oladi.
2. To’plam o’zgaruvchilari to’plamning asosiy muhitiga (Manage Environments) tushadi; u yerda secret_token belgilanadi.
3. Kirish tokenini olish amalini bajaring — skript tokenlarni xuddi shu muhitga yozib qo’yadi.

Yangilash

To’plam OpenAPI spetsifikatsiyasi asosida generatsiya qilinadi va qo’lda tahrirlanmaydi: spetsifikatsiya o’zgarsa — to’plam u bilan birga repozitoriyda qayta yig’iladi va yangilanadi.