API reference

API reference

Base URL: https://dev.adolfjon.uz/v1. Every request needs Authorization: Bearer <key> except /v1/ping. All responses are JSON in the same shape: {"ok": true, "data": …, "meta": {…}} on success and {"ok": false, "error": {…}} on failure.

Machine-readable spec: /openapi.json (OpenAPI 3.1). Postman: download the collection, then set the apiKey variable.

Meta

EndpointWhat it doesPermission
GET /v1/key Inspect your key none
GET /v1/ping Ping none

Catalog

EndpointWhat it doesPermission
GET /v1/catalog/categories List categories catalog:read
GET /v1/catalog/products List products catalog:read
GET /v1/catalog/products/{id} Get a product catalog:read
GET /v1/news List news catalog:read

Account

EndpointWhat it doesPermission
GET /v1/me Your profile account:read
GET /v1/me/balance Your balance balance:read
GET /v1/me/balance/transactions Balance history balance:read
GET /v1/me/orders Your orders orders:read
GET /v1/me/orders/{id} Get an order orders:read
GET /v1/me/licenses Your plan licenses:read
GET /v1/me/boost Your Hour Boost boost:read
GET /v1/me/notifications Your notifications notifications:read