Справочник API

Все эндпоинты доступны по адресу https://api.bazex.co/app-api. Для аутентификации передавайте токен доступа в заголовке Authorization.

Базовый URL и аутентификация

curl https://api.bazex.co/app-api/products \
  -H "Authorization: Bearer fbat_your_access_token"

Ограничения запросов

Каждая установка приложения ограничена 60 запросами в минуту. Информация о лимитах включена в каждый ответ:

Заголовок	Описание
X-RateLimit-Limit	Максимум запросов за окно (60)
X-RateLimit-Remaining	Оставшиеся запросы в текущем окне
X-RateLimit-Reset	Unix-метка времени сброса окна

При превышении лимита API возвращает 429 Too Many Requests с заголовком Retry-After.

Пагинация

Эндпоинты списков возвращают результаты с пагинацией. Передавайте page и limit как query-параметры:

Query-параметры

Name	Type	Required	Description
page	number	No	Номер страницы (по умолчанию: 1)
limit	number	No	Элементов на странице (значения по умолчанию зависят от эндпоинта — см. ниже)

Эндпоинт	Лимит по умолчанию	Макс. лимит
/app-api/products	50	100
/app-api/orders	20	50
/app-api/reviews	10	50

Ответ с пагинациейjson

{
  "data": [ ... ],
  "total": 42,
  "page": 1,
  "limit": 20
}

Формат ошибок

{
  "statusCode": 404,
  "message": "Product not found",
  "error": "Not Found"
}

Товары

Доступ к каталогу товаров мерчанта.

GET

/app-api/products

Список всех товаров (с пагинацией)

read_products

GET

/app-api/products/:id

Получить товар по ID

read_products

GET

/app-api/products/slug/:slug

Получить товар по slug

read_products

Список товаров

Запросbash

curl https://api.bazex.co/app-api/products?page=1&limit=20 \
  -H "Authorization: Bearer fbat_..."

Ответjson

{
  "data": [
    {
      "id": "clx1abc2def3",
      "name": "Margherita Pizza",
      "description": "Classic Italian pizza",
      "price": 590,
      "category": "Pizza",
      "isAvailable": true,
      "imageUrl": "/uploads/products/pizza.jpg",
      "slug": "margherita-pizza",
      "status": "ACTIVE",
      "createdAt": "2026-01-15T10:30:00.000Z"
    }
  ],
  "total": 42,
  "page": 1,
  "limit": 20
}

Заказы

Просмотр и управление заказами мерчанта.

GET

/app-api/orders

Список всех заказов (с пагинацией)

read_orders

GET

/app-api/orders/:id

Получить заказ по ID

read_orders

PATCH

/app-api/orders/:id/status

Обновить статус заказа

write_orders

POST

/app-api/orders

Создать гостевой заказ

write_orders

Обновить статус заказа

Запросbash

curl -X PATCH https://api.bazex.co/app-api/orders/ORDER_ID/status \
  -H "Authorization: Bearer fbat_..." \
  -H "Content-Type: application/json" \
  -d '{ "status": "CONFIRMED" }'

Допустимые статусы

Name	Type	Required	Description
PENDING	string	No	Заказ получен, ожидает подтверждения
CONFIRMED	string	No	Заказ подтверждён бизнесом
PREPARING	string	No	Заказ готовится
READY	string	No	Заказ готов к выдаче/доставке
IN_DELIVERY	string	No	Заказ в доставке
DELIVERED	string	No	Заказ доставлен
CANCELLED	string	No	Заказ отменён

Отзывы

Доступ к отзывам мерчанта.

GET

/app-api/reviews

Список отзывов (с пагинацией)

read_reviews

GET

/app-api/reviews/stats

Агрегированная статистика отзывов

read_reviews

Аналитика

GET

/app-api/analytics/dashboard

Получить данные аналитического дашборда

read_analytics

Бизнес

GET

/app-api/business

Получить информацию о бизнесе (название, адрес, тип и т.д.)

read_business

Страницы

GET

/app-api/pages

Список страниц сайта

read_pages

GET

/app-api/pages/:slug

Получить страницу по slug

read_pages

ℹ

Кросс-тенантная безопасность

Токен доступа привязан к одному мерчанту. Все ответы API автоматически фильтруются по данным этого мерчанта. Попытка обратиться к ресурсам другого мерчанта возвращает 404.

Справочник API

Базовый URL и аутентификация

curl https://api.bazex.co/app-api/products \
  -H "Authorization: Bearer fbat_your_access_token"

Ограничения запросов

Каждая установка приложения ограничена 60 запросами в минуту. Информация о лимитах включена в каждый ответ:

Заголовок	Описание
X-RateLimit-Limit	Максимум запросов за окно (60)
X-RateLimit-Remaining	Оставшиеся запросы в текущем окне
X-RateLimit-Reset	Unix-метка времени сброса окна

При превышении лимита API возвращает 429 Too Many Requests с заголовком Retry-After.

Пагинация

Эндпоинты списков возвращают результаты с пагинацией. Передавайте page и limit как query-параметры:

Query-параметры

Name	Type	Required	Description
page	number	No	Номер страницы (по умолчанию: 1)
limit	number	No	Элементов на странице (значения по умолчанию зависят от эндпоинта — см. ниже)

Эндпоинт	Лимит по умолчанию	Макс. лимит
/app-api/products	50	100
/app-api/orders	20	50
/app-api/reviews	10	50

Ответ с пагинациейjson

{
  "data": [ ... ],
  "total": 42,
  "page": 1,
  "limit": 20
}

Формат ошибок

{
  "statusCode": 404,
  "message": "Product not found",
  "error": "Not Found"
}

Товары

Доступ к каталогу товаров мерчанта.

GET

/app-api/products

Список всех товаров (с пагинацией)

read_products

GET

/app-api/products/:id

Получить товар по ID

read_products

GET

/app-api/products/slug/:slug

Получить товар по slug

read_products

Список товаров

Запросbash

curl https://api.bazex.co/app-api/products?page=1&limit=20 \
  -H "Authorization: Bearer fbat_..."

Ответjson

{
  "data": [
    {
      "id": "clx1abc2def3",
      "name": "Margherita Pizza",
      "description": "Classic Italian pizza",
      "price": 590,
      "category": "Pizza",
      "isAvailable": true,
      "imageUrl": "/uploads/products/pizza.jpg",
      "slug": "margherita-pizza",
      "status": "ACTIVE",
      "createdAt": "2026-01-15T10:30:00.000Z"
    }
  ],
  "total": 42,
  "page": 1,
  "limit": 20
}

Заказы

Просмотр и управление заказами мерчанта.

GET

/app-api/orders

Список всех заказов (с пагинацией)

read_orders

GET

/app-api/orders/:id

Получить заказ по ID

read_orders

PATCH

/app-api/orders/:id/status

Обновить статус заказа

write_orders

POST

/app-api/orders

Создать гостевой заказ

write_orders

Обновить статус заказа

Запросbash

curl -X PATCH https://api.bazex.co/app-api/orders/ORDER_ID/status \
  -H "Authorization: Bearer fbat_..." \
  -H "Content-Type: application/json" \
  -d '{ "status": "CONFIRMED" }'

Допустимые статусы

Name	Type	Required	Description
PENDING	string	No	Заказ получен, ожидает подтверждения
CONFIRMED	string	No	Заказ подтверждён бизнесом
PREPARING	string	No	Заказ готовится
READY	string	No	Заказ готов к выдаче/доставке
IN_DELIVERY	string	No	Заказ в доставке
DELIVERED	string	No	Заказ доставлен
CANCELLED	string	No	Заказ отменён

Отзывы

Доступ к отзывам мерчанта.

GET

/app-api/reviews

Список отзывов (с пагинацией)

read_reviews

GET

/app-api/reviews/stats

Агрегированная статистика отзывов

read_reviews

Аналитика

GET

/app-api/analytics/dashboard

Получить данные аналитического дашборда

read_analytics

Бизнес

GET

/app-api/business

Получить информацию о бизнесе (название, адрес, тип и т.д.)

read_business

Страницы

GET

/app-api/pages

Список страниц сайта

read_pages

GET

/app-api/pages/:slug

Получить страницу по slug

read_pages

ℹ

Кросс-тенантная безопасность