API ma’lumotnomasi

01Asosiy qoidalar#

So‘rovlar JSON orqali yuboriladi; firmware upload multipart/form-data ishlatadi. Global ValidationPipe DTO’da yo‘q maydonlarni rad etadi va belgilangan transform’larni qo‘llaydi. API javoblari barcha endpointlarda bir xil wrapper’ga ega emas.

Xavfsiz health so‘rovi

curl --fail --silent https://api.hamrohio.uz/health

Health javobining shakli

{
  "status": "ok",
  "checks": { "api": true, "database": true, "objectStorage": true },
  "timestamp": "2026-09-10T00:00:00.000Z"
}

02Autentifikatsiya#

Oqim	Credential	Qo‘llanish
Admin	hamroh_admin cookie	Login’dan keyingi 12 soatlik sessiya. Har route roli alohida tekshiriladi.
Pairing	Authorization: Bearer <credential>	Bog‘langan installation uchun /devices/me va revoke. Refresh credential’ni body’da qabul qiladi.
Device proof	x-hamroh-timestamp + x-hamroh-proof	Heartbeat, firmware latest, report va current installation. Ikkala header birga talab qilinadi.
Public	Sessiyasiz, rate-limit bilan	Health va preorder oqimi. Pairing challenge/claim credential chiqarishdan oldin maxsus proof tekshiradi.

Device timestamp Unix millisekundlarda bo‘lib, server vaqtidan ±5 daqiqa ichida bo‘lishi kerak. Proof HMAC-SHA256’ning hex ko‘rinishi; uni Desktop qurilmadan oladi. Qurilma secret’ini brauzerga yoki integratsiya skriptiga ko‘chirish kerak emas.

Operatsiya	Proof payload
heartbeat	timestamp.serial.firmwareVersion.uptime
firmware/latest	timestamp.serial.currentFirmware
installations/current	timestamp.serial.installation-status.installationId-or-latest
firmware/report	timestamp.serial.releaseId.installationId.status

Report uchun installationId berilmagan eski kontraktda payload timestamp.serial.releaseId.status bo‘ladi. Timestamp oynasi yangilikni tekshiradi, lekin har so‘rov uchun bir martalik nonce kafolati emas.

03Muhim integratsiya oqimlari#

Pairing: challenge → hardware proof → claim → credential. Challenge 5 daqiqadan keyin tugaydi.
Firmware: package inspect → Admin izohi va kanal/target → DRAFT → READY → ROLLING_OUT. READY avtomatik rollout emas.
Preorder: public config → idempotency-key bilan create. Bir xil so‘rov va bir xil kalit dublikat yaratmasligi kerak.

04Xatolar va limitlar#

Xato javobining shakli

{
  "error": {
    "code": "ADMIN_AUTH_REQUIRED",
    "message": "Admin authentication is required.",
    "requestId": "example-request-id"
  }
}

Status	Ma’nosi	Mijoz harakati
400	DTO yoki biznes qoidasi buzildi	So‘rovni tuzatish
401 / 403	Credential yoki rol mos emas	Sessiya/proof va ruxsatni tekshirish
409	Dublikat yoki lifecycle konflikti	Joriy holatni qayta o‘qish
429	Rate limit	Kutish; cheksiz retry qilmaslik
5xx	Servis muammosi	requestId’ni saqlash va holatni tekshirish

Standart throttler 60 soniyada 120 so‘rov bilan sozlangan; login 5/min, pairing challenge 10/min, claim 5/min, package inspect 10/min va package create 5/min kabi route limitlari mavjud. Joriy konfiguratsiya shared distributed rate-limit storage’ni ko‘rsatmaydi.

05Endpoint katalogi#

Katalogda method, path, kirish roli va DTO maydonlari ko‘rsatiladi. Response sxemasi faqat koddan alohida tekshirilgan joylarda berilgan; qolgan endpointlar uchun to‘liq javob shakli taxmin qilinmagan.

80 endpoint

GET/v1/admin/teamadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN
Rate limit: 120 / 60s

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/admin-users/admin-users.controller.ts:12

POST/v1/admin/teamadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN
Rate limit: 120 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`name`	`string`Majburiy	minLength: 2; maxLength: 120
`email`	`string`Majburiy	format: email; minLength: 3; maxLength: 160
`role`	`string`Majburiy	SUPER_ADMIN · ADMIN · OPERATIONS · SALES · SUPPORT · FIRMWARE_MANAGER · VIEWER

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/admin-users/admin-users.controller.ts:20

GET/v1/admin/team/optionsadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS, SALES, SUPPORT, VIEWER
Rate limit: 120 / 60s

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/admin-users/admin-users.controller.ts:16

PATCH/v1/admin/team/{id}/roleadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`role`	`string`Majburiy	SUPER_ADMIN · ADMIN · OPERATIONS · SALES · SUPPORT · FIRMWARE_MANAGER · VIEWER

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/admin-users/admin-users.controller.ts:24

PATCH/v1/admin/team/{id}/statusadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`status`	`string`Majburiy	ACTIVE · SUSPENDED · DISABLED

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/admin-users/admin-users.controller.ts:30

POST/v1/admin/team/{id}/reset-passwordadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/admin-users/admin-users.controller.ts:36

POST/v1/admin/team/{id}/revoke-sessionsadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/admin-users/admin-users.controller.ts:42

GET/v1/admin/analytics/salesadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS, SALES, SUPPORT, VIEWER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`range`	query	stringtoday · 7d · 30d · 90d · year · custom; default: 30d	—
`from`	query	string	—
`to`	query	string	—
`currency`	query	stringdefault: UZS	—

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/analytics/analytics.controller.ts:12

GET/v1/admin/analytics/operationsadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS, SALES, SUPPORT, VIEWER
Rate limit: 120 / 60s

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/analytics/analytics.controller.ts:13

GET/v1/admin/auditadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SUPPORT, VIEWER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`skip`	query	string	—
`take`	query	string	—
`action`	query	string	—

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/audit/audit.controller.ts:11

POST/v1/admin/auth/loginPublic

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: Public
Rollar: —
Rate limit: 5 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`email`	`string`Majburiy	format: email
`password`	`string`Majburiy	format: password; minLength: 8

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/auth/auth.controller.ts:12

POST/v1/admin/auth/logoutPublic

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: Public
Rollar: —
Rate limit: 120 / 60s

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/auth/auth.controller.ts:19

GET/v1/admin/auth/meadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: —
Rate limit: 120 / 60s

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/auth/auth.controller.ts:26

PUT/v1/admin/auth/passwordadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: —
Rate limit: 120 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`currentPassword`	`string`Majburiy	format: password; minLength: 8; maxLength: 128
`newPassword`	`string`Majburiy	format: password; minLength: 12; maxLength: 128; pattern: ^(?=.[a-z])(?=.[A-Z])(?=.\d)(?=.[^A-Za-z0-9]).+$

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/auth/auth.controller.ts:32

GET/v1/admin/auth/sessionsadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: —
Rate limit: 120 / 60s

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/auth/auth.controller.ts:37

DELETE/v1/admin/auth/sessions/{id}adminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: —
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/auth/auth.controller.ts:40

GET/v1/admin/customersadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SALES, SUPPORT, VIEWER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`search`	query	string	—
`preorderStatus`	query	stringNEW · CONTACTED · CONFIRMED · PAYMENT_PENDING · DEPOSIT_PAID · READY_TO_SHIP · FULFILLED · CANCELLED	—
`source`	query	string	—
`language`	query	stringuz · en · ru	—
`assignedAdminId`	query	string	—
`dateFrom`	query	stringformat: date-time	—
`dateTo`	query	stringformat: date-time	—
`skip`	query	integerminimum: 0; default: 0	—
`take`	query	integerminimum: 1; maximum: 100; default: 25	—

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/customers/customers.controller.ts:12

POST/v1/admin/customersadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SALES
Rate limit: 120 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`fullName`	`string`Majburiy	minLength: 2; maxLength: 120
`email`	`string`Ixtiyoriy	format: email
`phone`	`string`Ixtiyoriy	minLength: 5; maxLength: 32
`company`	`string`Ixtiyoriy	minLength: 2; maxLength: 120
`country`	`string`Ixtiyoriy	minLength: 2; maxLength: 80
`city`	`string`Ixtiyoriy	minLength: 2; maxLength: 80
`region`	`string`Ixtiyoriy	minLength: 2; maxLength: 80
`telegramUsername`	`string`Ixtiyoriy	minLength: 5; maxLength: 32
`preferredLanguage`	`string`Ixtiyoriy	uz · en · ru
`notes`	`string`Ixtiyoriy	minLength: 0; maxLength: 1000

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/customers/customers.controller.ts:23

GET/v1/admin/customers/export.csvadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SALES
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`search`	query	string	—
`preorderStatus`	query	stringNEW · CONTACTED · CONFIRMED · PAYMENT_PENDING · DEPOSIT_PAID · READY_TO_SHIP · FULFILLED · CANCELLED	—
`source`	query	string	—
`language`	query	stringuz · en · ru	—
`assignedAdminId`	query	string	—
`dateFrom`	query	stringformat: date-time	—
`dateTo`	query	stringformat: date-time	—
`skip`	query	integerminimum: 0; default: 0	—
`take`	query	integerminimum: 1; maximum: 100; default: 25	—

Javob

HTTP 200 · text/csv

apps/api/src/customers/customers.controller.ts:14

GET/v1/admin/customers/{id}adminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SALES, SUPPORT, VIEWER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/customers/customers.controller.ts:21

PATCH/v1/admin/customers/{id}adminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SALES
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`fullName`	`string`Ixtiyoriy	minLength: 2; maxLength: 120
`email`	`string`Ixtiyoriy	format: email
`phone`	`string`Ixtiyoriy	minLength: 5; maxLength: 32
`company`	`string`Ixtiyoriy	minLength: 2; maxLength: 120
`country`	`string`Ixtiyoriy	minLength: 2; maxLength: 80
`city`	`string`Ixtiyoriy	minLength: 2; maxLength: 80
`region`	`string`Ixtiyoriy	minLength: 2; maxLength: 80
`telegramUsername`	`string`Ixtiyoriy	minLength: 5; maxLength: 32
`preferredLanguage`	`string`Ixtiyoriy	uz · en · ru
`notes`	`string`Ixtiyoriy	minLength: 0; maxLength: 1000

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/customers/customers.controller.ts:25

GET/v1/admin/devicesadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS, SALES, SUPPORT, VIEWER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`search`	query	string	—
`status`	query	stringINVENTORY · READY · SOLD · CLAIMED · ACTIVE · RETURNED · SUSPENDED · REVOKED · REPAIR · RETIRED	—
`hardwareRevision`	query	string	—
`firmware`	query	string	—
`batch`	query	string	—
`skip`	query	integerminimum: 0; default: 0	—
`take`	query	integerminimum: 1; maximum: 100; default: 50	—

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:12

GET/v1/admin/devices/{id}adminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS, SALES, SUPPORT, VIEWER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:15

GET/v1/admin/claim-codesadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SUPPORT, VIEWER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`skip`	query	string	—
`take`	query	string	—
`status`	query	string	—

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:18

POST/v1/admin/devices/batchesadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN
Rate limit: 120 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`batchCode`	`string`Majburiy	minLength: 3; maxLength: 64
`model`	`string`Majburiy	minLength: 2; maxLength: 32
`hardwareRevision`	`string`Majburiy	minLength: 1; maxLength: 64
`quantity`	`integer`Majburiy	minimum: 1; maximum: 500
`expiresAt`	`string`Ixtiyoriy	—

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:23

GET/v1/admin/inventory/batchesadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS, SUPPORT, VIEWER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`search`	query	string	—
`status`	query	stringDRAFT · READY · PROVISIONING · COMPLETED · ARCHIVED · CANCELLED	—
`skip`	query	integerminimum: 0; default: 0	—
`take`	query	integerminimum: 1; maximum: 100; default: 50	—

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:26

POST/v1/admin/inventory/batchesadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS
Rate limit: 120 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`code`	`string`Majburiy	minLength: 3; maxLength: 64
`model`	`string`Majburiy	minLength: 2; maxLength: 32
`hardwareRevision`	`string`Majburiy	minLength: 1; maxLength: 64
`quantity`	`integer`Majburiy	minimum: 1; maximum: 500
`notes`	`string`Ixtiyoriy	minLength: 0; maxLength: 1000
`source`	`string`Ixtiyoriy	minLength: 1; maxLength: 64

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:29

GET/v1/admin/inventory/batches/{id}adminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS, SUPPORT, VIEWER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:32

PATCH/v1/admin/inventory/batches/{id}adminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`code`	`string`Ixtiyoriy	minLength: 3; maxLength: 64
`model`	`string`Ixtiyoriy	minLength: 2; maxLength: 32
`hardwareRevision`	`string`Ixtiyoriy	minLength: 1; maxLength: 64
`quantity`	`integer`Ixtiyoriy	minimum: 1; maximum: 500
`notes`	`string`Ixtiyoriy	minLength: 0; maxLength: 1000
`source`	`string`Ixtiyoriy	minLength: 1; maxLength: 64
`status`	`string`Ixtiyoriy	DRAFT · READY · PROVISIONING · COMPLETED · ARCHIVED · CANCELLED

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:35

DELETE/v1/admin/inventory/batches/{id}adminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN
Rate limit: 10 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:44

POST/v1/admin/inventory/batches/{id}/provisionadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS
Rate limit: 10 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`expiresAt`	`string`Ixtiyoriy	—

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:38

POST/v1/admin/inventory/batches/{id}/archiveadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:41

PATCH/v1/admin/devices/{id}/statusadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SUPPORT
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`status`	`string`Majburiy	INVENTORY · READY · SOLD · CLAIMED · ACTIVE · RETURNED · SUSPENDED · REVOKED · REPAIR · RETIRED
`reason`	`string`Majburiy	minLength: 3

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:47

POST/v1/admin/devices/{id}/claim/resetadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SUPPORT
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`reason`	`string`Majburiy	minLength: 3
`expiresAt`	`string`Ixtiyoriy	—

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:50

POST/v1/admin/devices/{id}/transferadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SUPPORT
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`customerEmail`	`string`Majburiy	format: email
`customerName`	`string`Ixtiyoriy	—
`reason`	`string`Majburiy	minLength: 3

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:53

POST/v1/admin/devices/{id}/provisioning-envelopeadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, OPERATIONS
Rate limit: 3 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`serialNumber`	`string`Majburiy	minLength: 16; maxLength: 40
`expectedHardwareRevision`	`string`Majburiy	minLength: 1; maxLength: 64
`provisionerPublicKey`	`string`Majburiy	minLength: 256; maxLength: 8192

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:56

POST/v1/devices/heartbeatdeviceProof + deviceTimestamp

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: deviceProof + deviceTimestamp
Rollar: —
Rate limit: 120 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`serial`	`string`Majburiy	—
`firmwareVersion`	`string`Majburiy	—
`firmwareBuildNumber`	`integer`Ixtiyoriy	minimum: 0
`hardwareRevision`	`string`Ixtiyoriy	minLength: 1; maxLength: 64
`otaSlot`	`string`Ixtiyoriy	ota_0 · ota_1
`appVersion`	`string`Majburiy	—
`uptime`	`integer`Majburiy	minimum: 0
`wifiRSSI`	`integer`Ixtiyoriy	minimum: -120; maximum: 0
`freeHeap`	`integer`Ixtiyoriy	minimum: 0
`temperature`	`number`Ixtiyoriy	minimum: -40; maximum: 125
`status`	`string`Ixtiyoriy	default: healthy

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/devices/devices.controller.ts:61

GET/v1/admin/firmwareadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, FIRMWARE_MANAGER, VIEWER
Rate limit: 120 / 60s

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/firmware/firmware.controller.ts:15

POST/v1/admin/firmwareLegacyadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation. Legacy binary upload. Prefer the signed package route.

Auth: adminCookie
Rollar: SUPER_ADMIN
Rate limit: 120 / 60s

So‘rov `multipart/form-data`

Maydon	Tur / talab	Cheklov
`version`	`string`Majburiy	pattern: ^\d{1,4}\.\d{1,4}\.\d{1,4}$
`buildNumber`	`integer`Majburiy	minimum: 1; maximum: 2147483647
`hardwareRevision`	`string`Majburiy	pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{0,63}$
`channel`	`string`Majburiy	INTERNAL · BETA · STABLE
`securityVersion`	`integer`Ixtiyoriy	minimum: 0; default: 0
`releaseNotes`	`string[]`Majburiy	—
`mandatory`	`boolean`Ixtiyoriy	default: false
`mandatoryAfter`	`string`Ixtiyoriy	format: date-time
`rolloutPercentage`	`integer`Ixtiyoriy	minimum: 0; maximum: 100; default: 0
`signature`	`string`Ixtiyoriy	—
`targetDeviceId`	`string`Ixtiyoriy	—
`file`	`file`Majburiy	format: binary

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/firmware/firmware.controller.ts:32

GET/v1/admin/firmware/package-devicesadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, FIRMWARE_MANAGER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`hardwareRevision`	query	stringmaxLength: 64	Ha
`search`	query	stringmaxLength: 64	—

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/firmware/firmware.controller.ts:18

POST/v1/admin/firmware/packages/inspectadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, FIRMWARE_MANAGER
Rate limit: 10 / 60s

So‘rov `multipart/form-data`

Maydon	Tur / talab	Cheklov
`file`	`file`Majburiy	format: binary

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/firmware/firmware.controller.ts:21

POST/v1/admin/firmware/packagesadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation. Signed .hrelease only; administrator-authored releaseNotes required. INTERNAL requires a compatible targetDeviceId. Creates DRAFT only.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, FIRMWARE_MANAGER
Rate limit: 5 / 60s

So‘rov `multipart/form-data`

Maydon	Tur / talab	Cheklov
`channel`	`string`Majburiy	INTERNAL · BETA · STABLE
`targetDeviceId`	`string`Ixtiyoriy	minLength: 1; maxLength: 64
`mandatory`	`boolean`Ixtiyoriy	default: false
`releaseNotes`	`string`Majburiy	minLength: 1; maxLength: 8000
`file`	`file`Majburiy	format: binary

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/firmware/firmware.controller.ts:25

GET/v1/admin/firmware/{id}adminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, FIRMWARE_MANAGER, VIEWER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/firmware/firmware.controller.ts:29

PATCH/v1/admin/firmware/{id}/lifecycleadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, FIRMWARE_MANAGER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`status`	`string`Majburiy	DRAFT · READY · ROLLING_OUT · PAUSED · COMPLETED · REVOKED
`rolloutPercentage`	`integer`Ixtiyoriy	minimum: 0; maximum: 100

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/firmware/firmware.controller.ts:35

POST/v1/admin/firmware/{id}/maintenance-grantadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, FIRMWARE_MANAGER
Rate limit: 3 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`expectedMac`	`string`Majburiy	pattern: ^[0-9a-fA-F]{2}(?::[0-9a-fA-F]{2}){5}$
`targetSerial`	`string`Majburiy	minLength: 1
`expectedVersion`	`string`Majburiy	minLength: 1
`expectedBuild`	`integer`Majburiy	minimum: 1
`expectedHardwareRevision`	`string`Majburiy	minLength: 1
`maintenancePurpose`	`string`Majburiy	ONE_TIME_IDENTITY_PROVISIONING

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/firmware/firmware.controller.ts:38

POST/v1/admin/firmware/installations/{installationId}/reconcileadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, FIRMWARE_MANAGER
Rate limit: 3 / 60s

Parametrlar

Name	In	Type	Majburiy
`installationId`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`releaseId`	`string`Majburiy	minLength: 1
`serial`	`string`Majburiy	minLength: 1
`expectedVersion`	`string`Majburiy	minLength: 1
`expectedBuild`	`integer`Majburiy	minimum: 1
`expectedSlot`	`string`Majburiy	ota_0 · ota_1
`observedBootState`	`string`Majburiy	valid
`observedOtaSessionState`	`string`Majburiy	IDLE
`reason`	`string`Majburiy	POST_BOOT_FALSE_NEGATIVE_RECONCILIATION

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/firmware/firmware.controller.ts:43

GET/v1/firmware/latestdeviceProof + deviceTimestamp

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation. IMPORTANT: eligibility lookup can create an AVAILABLE installation record; this GET is not side-effect-free.

Auth: deviceProof + deviceTimestamp
Rollar: —
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`serial`	query	string	Ha
`hardwareRevision`	query	string	Ha
`currentFirmware`	query	string	Ha
`appVersion`	query	string	Ha
`channel`	query	stringINTERNAL · BETA · STABLE; default: STABLE	—

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/firmware/firmware.controller.ts:48

POST/v1/admin/firmware/installations/{installationId}/interruptionadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, FIRMWARE_MANAGER
Rate limit: 3 / 60s

Parametrlar

Name	In	Type	Majburiy
`installationId`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`releaseId`	`string`Majburiy	minLength: 1; maxLength: 64
`serial`	`string`Majburiy	minLength: 1; maxLength: 64
`expectedVersion`	`string`Majburiy	minLength: 1; maxLength: 32
`expectedBuild`	`integer`Majburiy	minimum: 1
`expectedFailureReason`	`string`Majburiy	minLength: 1; maxLength: 256
`failureCode`	`string`Majburiy	USER_CANCELLED_BY_OPERATOR

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/firmware/firmware.controller.ts:51

GET/v1/firmware/installations/currentdeviceProof + deviceTimestamp

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation. Read-only recovery lookup: does not create an installation or sign a download URL.

Auth: deviceProof + deviceTimestamp
Rollar: —
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`serial`	query	stringminLength: 1; maxLength: 64	Ha
`installationId`	query	stringminLength: 1; maxLength: 64	—

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/firmware/firmware.controller.ts:57

POST/v1/firmware/reportdeviceProof + deviceTimestamp

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: deviceProof + deviceTimestamp
Rollar: —
Rate limit: 120 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`serial`	`string`Majburiy	—
`releaseId`	`string`Majburiy	—
`installationId`	`string`Ixtiyoriy	—
`status`	`string`Majburiy	AVAILABLE · QUEUED · DOWNLOADING · VERIFYING · TRANSFERRING · INSTALLING · REBOOTING · VALIDATING · SUCCESS · FAILED · ROLLED_BACK
`fromVersion`	`string`Ixtiyoriy	—
`failureReason`	`string`Ixtiyoriy	—

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/firmware/firmware.controller.ts:62

GET/healthPublic

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: Public
Rollar: —
Rate limit: 120 / 60s

Javob

HTTP 200 · application/json

Maydon	Tur / talab	Cheklov
`status`	`string`Majburiy	ok · degraded
`checks`	`object`Majburiy	—
`timestamp`	`string`Majburiy	format: date-time

apps/api/src/health/health.controller.ts:9

POST/v1/devices/pair/challengePublic

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: Public
Rollar: —
Rate limit: 10 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`serial`	`string`Majburiy	minLength: 8
`installationId`	`string`Majburiy	minLength: 16; maxLength: 128

Javob

HTTP 201 · application/json

Maydon	Tur / talab	Cheklov
`challengeId`	`string`Ixtiyoriy	—
`serial`	`string`Ixtiyoriy	—
`nonce`	`string`Ixtiyoriy	—
`expiresAt`	`string`Ixtiyoriy	format: date-time
`proofPayload`	`string`Ixtiyoriy	—

apps/api/src/pairing/pairing.controller.ts:10

POST/v1/devices/pair/claimPublic

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: Public
Rollar: —
Rate limit: 5 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`serial`	`string`Majburiy	minLength: 8
`installationId`	`string`Majburiy	minLength: 16; maxLength: 128
`challengeId`	`string`Majburiy	minLength: 16
`nonce`	`string`Majburiy	minLength: 24
`claimCode`	`string`Majburiy	minLength: 16
`hardwareProof`	`string`Majburiy	minLength: 32
`publicKey`	`string`Majburiy	minLength: 8
`deviceName`	`string`Majburiy	minLength: 1; maxLength: 128
`appVersion`	`string`Majburiy	minLength: 1; maxLength: 32
`customerEmail`	`string`Ixtiyoriy	format: email
`customerName`	`string`Ixtiyoriy	—

Javob

HTTP 201 · application/json

Maydon	Tur / talab	Cheklov
`credential`	`string`Ixtiyoriy	—
`expiresAt`	`string`Ixtiyoriy	format: date-time
`device`	`object`Ixtiyoriy	—
`offlineCapable`	`boolean`Ixtiyoriy	—

apps/api/src/pairing/pairing.controller.ts:13

POST/v1/devices/pair/code-statusPublic

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: Public
Rollar: —
Rate limit: 8 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`claimCode`	`string`Majburiy	minLength: 16

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/pairing/pairing.controller.ts:16

POST/v1/devices/pair/refreshPublic

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: Public
Rollar: —
Rate limit: 120 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`credential`	`string`Majburiy	minLength: 16

Javob

HTTP 201 · application/json

Maydon	Tur / talab	Cheklov
`credential`	`string`Ixtiyoriy	—
`expiresAt`	`string`Ixtiyoriy	format: date-time
`device`	`object`Ixtiyoriy	—
`offlineCapable`	`boolean`Ixtiyoriy	—

apps/api/src/pairing/pairing.controller.ts:20

POST/v1/devices/pair/revokepairingBearer

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: pairingBearer
Rollar: —
Rate limit: 120 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`installationId`	`string`Majburiy	minLength: 16; maxLength: 128

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/pairing/pairing.controller.ts:23

GET/v1/devices/mepairingBearer

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: pairingBearer
Rollar: —
Rate limit: 120 / 60s

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/pairing/pairing.controller.ts:26

GET/v1/public/preorder-configPublic

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: Public
Rollar: —
Rate limit: 60 / 60s

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/preorders/preorders.controller.ts:36

POST/v1/public/preordersPublic

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: Public
Rollar: —
Rate limit: 5 / 60s

Parametrlar

Name	In	Type	Majburiy
`idempotency-key`	header	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`fullName`	`string`Majburiy	minLength: 2; maxLength: 120
`phone`	`string`Majburiy	minLength: 8; maxLength: 32
`region`	`string`Majburiy	minLength: 2; maxLength: 80
`productColor`	`string`Ixtiyoriy	BLACK · WHITE · LAVENDER
`paymentMethod`	`string`Ixtiyoriy	DEPOSIT · FULL
`note`	`string`Ixtiyoriy	minLength: 1; maxLength: 500
`city`	`string`Ixtiyoriy	minLength: 2; maxLength: 80
`email`	`string`Ixtiyoriy	format: email; minLength: 3; maxLength: 160
`telegramUsername`	`string`Ixtiyoriy	pattern: ^@?[A-Za-z0-9_]{5,32}$
`quantity`	`integer`Ixtiyoriy	minimum: 1; maximum: 20; default: 1
`locale`	`string`Majburiy	uz · en · ru
`website`	`string`Ixtiyoriy	minLength: 0; maxLength: 0
`utmSource`	`string`Ixtiyoriy	minLength: 1; maxLength: 120
`utmMedium`	`string`Ixtiyoriy	minLength: 1; maxLength: 120
`utmCampaign`	`string`Ixtiyoriy	minLength: 1; maxLength: 160
`utmContent`	`string`Ixtiyoriy	minLength: 1; maxLength: 160
`utmTerm`	`string`Ixtiyoriy	minLength: 1; maxLength: 160
`referrer`	`string`Ixtiyoriy	format: uri; minLength: 1; maxLength: 500

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/preorders/preorders.controller.ts:40

POST/v1/public/preorder-events/viewPublic

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: Public
Rollar: —
Rate limit: 20 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`anonymousSessionId`	`string`Majburiy	pattern: ^[A-Za-z0-9_-]{16,96}$
`locale`	`string`Majburiy	uz · en · ru
`utmSource`	`string`Ixtiyoriy	minLength: 1; maxLength: 120
`utmMedium`	`string`Ixtiyoriy	minLength: 1; maxLength: 120
`utmCampaign`	`string`Ixtiyoriy	minLength: 1; maxLength: 160
`utmContent`	`string`Ixtiyoriy	minLength: 1; maxLength: 160
`utmTerm`	`string`Ixtiyoriy	minLength: 1; maxLength: 160
`referrer`	`string`Ixtiyoriy	format: uri; minLength: 1; maxLength: 500

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/preorders/preorders.controller.ts:50

GET/v1/admin/preordersadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS, SALES, SUPPORT, VIEWER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`search`	query	stringminLength: 1; maxLength: 160	—
`status`	query	stringNEW · CONTACTED · CONFIRMED · PAYMENT_PENDING · DEPOSIT_PAID · READY_TO_SHIP · FULFILLED · CANCELLED	—
`source`	query	stringminLength: 1; maxLength: 80	—
`locale`	query	stringuz · en · ru	—
`assignedAdminId`	query	string	—
`dateFrom`	query	stringformat: date-time	—
`dateTo`	query	stringformat: date-time	—
`skip`	query	integerminimum: 0; default: 0	—
`take`	query	integerminimum: 1; maximum: 200; default: 50	—

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/preorders/preorders.controller.ts:60

GET/v1/admin/preorders/analyticsadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS, SALES, SUPPORT, VIEWER
Rate limit: 120 / 60s

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/preorders/preorders.controller.ts:64

GET/v1/admin/preorders/export.csvadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SALES
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`search`	query	stringminLength: 1; maxLength: 160	—
`status`	query	stringNEW · CONTACTED · CONFIRMED · PAYMENT_PENDING · DEPOSIT_PAID · READY_TO_SHIP · FULFILLED · CANCELLED	—
`source`	query	stringminLength: 1; maxLength: 80	—
`locale`	query	stringuz · en · ru	—
`assignedAdminId`	query	string	—
`dateFrom`	query	stringformat: date-time	—
`dateTo`	query	stringformat: date-time	—
`skip`	query	integerminimum: 0; default: 0	—
`take`	query	integerminimum: 1; maximum: 200; default: 50	—

Javob

HTTP 200 · text/csv

apps/api/src/preorders/preorders.controller.ts:68

GET/v1/admin/preorders/{id}adminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS, SALES, SUPPORT, VIEWER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/preorders/preorders.controller.ts:77

DELETE/v1/admin/preorders/{id}adminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`preorderNumber`	`string`Majburiy	minLength: 8; maxLength: 40
`reason`	`string`Majburiy	minLength: 4; maxLength: 240

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/preorders/preorders.controller.ts:81

PATCH/v1/admin/preorders/{id}/statusadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SALES, SUPPORT
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`status`	`string`Majburiy	NEW · CONTACTED · CONFIRMED · PAYMENT_PENDING · DEPOSIT_PAID · READY_TO_SHIP · FULFILLED · CANCELLED
`note`	`string`Ixtiyoriy	minLength: 2; maxLength: 500

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/preorders/preorders.controller.ts:87

PATCH/v1/admin/preorders/{id}/assignmentadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SALES
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`adminId`	`string`Ixtiyoriy	minLength: 1; maxLength: 80; Conditional validation: inspect the operation policy.

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/preorders/preorders.controller.ts:93

POST/v1/admin/preorders/customers/{customerId}/notesadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SALES, SUPPORT
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`customerId`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`content`	`string`Majburiy	minLength: 2; maxLength: 2000

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/preorders/preorders.controller.ts:99

GET/v1/admin/preorder-settingsadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS, SALES, SUPPORT, VIEWER
Rate limit: 120 / 60s

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/preorders/preorders.controller.ts:115

PUT/v1/admin/preorder-settingsadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN
Rate limit: 120 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`preOrderEnabled`	`boolean`Majburiy	—
`productName`	`string`Majburiy	minLength: 2; maxLength: 120
`currency`	`string`Majburiy	pattern: ^[A-Z]{3}$
`fullPrice`	`integer`Ixtiyoriy	minimum: 0; maximum: 2000000000
`depositAmount`	`integer`Ixtiyoriy	minimum: 0; maximum: 2000000000
`expectedDeliveryTextUz`	`string`Majburiy	minLength: 2; maxLength: 240
`expectedDeliveryTextEn`	`string`Majburiy	minLength: 2; maxLength: 240
`expectedDeliveryTextRu`	`string`Majburiy	minLength: 2; maxLength: 240
`maxQuantityPerOrder`	`integer`Majburiy	minimum: 1; maximum: 20
`preorderCapacity`	`integer`Ixtiyoriy	minimum: 1; maximum: 1000000
`contactPhone`	`string`Ixtiyoriy	minLength: 5; maxLength: 32
`supportTelegram`	`string`Ixtiyoriy	format: uri; minLength: 8; maxLength: 300
`allowManualDepositConfirmation`	`boolean`Majburiy	—

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/preorders/preorders.controller.ts:119

GET/v1/admin/salesadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SALES, SUPPORT, VIEWER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`search`	query	string	—
`status`	query	stringDRAFT · PENDING · PAID · FULFILLED · CANCELLED · REFUNDED	—
`paymentStatus`	query	stringUNPAID · PARTIAL · PAID · REFUNDED	—
`channel`	query	stringDIRECT · INSTAGRAM · TELEGRAM · WEBSITE · RESELLER · OFFLINE · OTHER	—
`from`	query	string	—
`to`	query	string	—
`skip`	query	integerminimum: 0; default: 0	—
`take`	query	integerminimum: 1; maximum: 100; default: 25	—

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/sales/sales.controller.ts:12

POST/v1/admin/salesadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SALES
Rate limit: 120 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`customer`	`SaleCustomerDto`Majburiy	—
`deviceId`	`string`Majburiy	—
`unitPrice`	`integer`Majburiy	minimum: 0; maximum: 2000000000
`discount`	`integer`Ixtiyoriy	minimum: 0; maximum: 2000000000; default: 0
`currency`	`string`Ixtiyoriy	minLength: 3; maxLength: 3; default: UZS
`paymentStatus`	`string`Majburiy	UNPAID · PARTIAL · PAID · REFUNDED
`salesChannel`	`string`Majburiy	DIRECT · INSTAGRAM · TELEGRAM · WEBSITE · RESELLER · OFFLINE · OTHER
`soldAt`	`string`Ixtiyoriy	format: date-time
`notes`	`string`Ixtiyoriy	minLength: 0; maxLength: 1000

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/sales/sales.controller.ts:16

GET/v1/admin/sales/{id}adminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SALES, SUPPORT, VIEWER
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/sales/sales.controller.ts:14

PATCH/v1/admin/sales/{id}adminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SALES
Rate limit: 120 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`customerId`	`string`Ixtiyoriy	—
`paymentStatus`	`string`Ixtiyoriy	UNPAID · PARTIAL · PAID · REFUNDED
`salesChannel`	`string`Ixtiyoriy	DIRECT · INSTAGRAM · TELEGRAM · WEBSITE · RESELLER · OFFLINE · OTHER
`notes`	`string`Ixtiyoriy	minLength: 0; maxLength: 1000
`unitPrice`	`integer`Ixtiyoriy	minimum: 0; maximum: 2000000000
`discount`	`integer`Ixtiyoriy	minimum: 0; maximum: 2000000000

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/sales/sales.controller.ts:18

POST/v1/admin/sales/{id}/canceladminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SALES
Rate limit: 20 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`reason`	`string`Majburiy	minLength: 3

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/sales/sales.controller.ts:20

POST/v1/admin/sales/{id}/refundadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, SALES
Rate limit: 20 / 60s

Parametrlar

Name	In	Type	Majburiy
`id`	path	string	Ha

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`reason`	`string`Majburiy	minLength: 3
`amount`	`integer`Majburiy	minimum: 1; maximum: 2000000000
`deviceDisposition`	`string`Ixtiyoriy	RETURNED · REVOKED

Javob

HTTP 201 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/sales/sales.controller.ts:22

GET/v1/admin/overviewadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, OPERATIONS, SALES, SUPPORT, FIRMWARE_MANAGER, VIEWER
Rate limit: 120 / 60s

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/settings/settings.controller.ts:12

GET/v1/admin/settingsadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN, VIEWER
Rate limit: 120 / 60s

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/settings/settings.controller.ts:15

PUT/v1/admin/settingsadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN
Rate limit: 120 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`maximumMacsPerDevice`	`integer`Majburiy	minimum: 1; maximum: 10
`heartbeatTimeoutSeconds`	`integer`Majburiy	minimum: 60; maximum: 86400
`pairingCertificateDays`	`integer`Majburiy	minimum: 7; maximum: 730
`defaultFirmwareChannel`	`string`Majburiy	INTERNAL · BETA · STABLE
`defaultRolloutPercentage`	`integer`Majburiy	minimum: 0; maximum: 100

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/settings/settings.controller.ts:18

PUT/v1/admin/settings/businessadminCookie

Kirish siyosati

Request schema and access metadata extracted from controller and DTO source. Business rules may impose additional constraints. No live requests are sent by this documentation.

Auth: adminCookie
Rollar: SUPER_ADMIN, ADMIN
Rate limit: 120 / 60s

So‘rov `application/json`

Maydon	Tur / talab	Cheklov
`onlineThresholdMinutes`	`integer`Majburiy	minimum: 1; maximum: 1440
`activeThresholdDays`	`integer`Majburiy	minimum: 1; maximum: 365
`companyName`	`string`Majburiy	minLength: 2; maxLength: 120
`defaultCurrency`	`string`Majburiy	minLength: 3; maxLength: 3
`defaultDevicePrice`	`integer`Majburiy	minimum: 0; maximum: 2000000000
`orderNumberPrefix`	`string`Majburiy	minLength: 2; maxLength: 12

Javob

HTTP 200 · To‘liq javob sxemasi bu snapshot’da e’lon qilinmagan.

apps/api/src/settings/settings.controller.ts:21

01Asosiy qoidalar#

02Autentifikatsiya#

03Muhim integratsiya oqimlari#

04Xatolar va limitlar#

05Endpoint katalogi#

Kirish siyosati

Javob

Kirish siyosati

So‘rov application/json

Javob

Kirish siyosati

Javob

Kirish siyosati

Parametrlar

So‘rov application/json

Javob

Kirish siyosati

Parametrlar

So‘rov application/json

Javob

Kirish siyosati

Parametrlar

Javob

Kirish siyosati

Parametrlar

Javob

Kirish siyosati

Parametrlar

Javob

Kirish siyosati

Javob

Kirish siyosati

Parametrlar

Javob

Kirish siyosati

So‘rov application/json

Javob

Kirish siyosati

Javob

Kirish siyosati

Javob

Kirish siyosati

So‘rov application/json

Javob

Kirish siyosati

Javob

Kirish siyosati

Parametrlar

Javob

Kirish siyosati

Parametrlar

Javob

Kirish siyosati

So‘rov application/json

Javob

Kirish siyosati

Parametrlar

Javob

Kirish siyosati

Parametrlar

Javob

Kirish siyosati

Parametrlar

So‘rov application/json

Javob

Kirish siyosati

Parametrlar

Javob

Kirish siyosati

Parametrlar

Javob

Kirish siyosati

Parametrlar

Javob

Kirish siyosati

So‘rov application/json

Javob

Kirish siyosati

Parametrlar

Javob

So‘rov `application/json`

So‘rov `application/json`

So‘rov `application/json`

So‘rov `application/json`

So‘rov `application/json`

So‘rov `application/json`

So‘rov `application/json`

So‘rov `application/json`

So‘rov `application/json`

So‘rov `application/json`

So‘rov `application/json`

So‘rov `application/json`

So‘rov `application/json`

So‘rov `application/json`

So‘rov `application/json`

So‘rov `application/json`

So‘rov `multipart/form-data`

So‘rov `multipart/form-data`

So‘rov `multipart/form-data`

So‘rov `application/json`

So‘rov `application/json`

So‘rov `application/json`