logo
API docs by Redocly

Base SSTMK API (1.0.0)

Download OpenAPI specification:

🚀 Base SSTMK API

API платформы Base SSTMK предназначен для интеграции партнёрских систем с каталогом продукции, брендами и проектами.

С помощью API вы можете:

  • получать каталоги и товары
  • строить витрины и интерфейсы
  • интегрировать данные в CRM или ERP
  • использовать проекты для аналитики и визуализации

📌 Общая логика работы

API построено по REST-принципам и использует JSON.

Типичный сценарий работы:

  1. Авторизация → получение JWT токена
  2. Получение доступных каталогов
  3. Получение товаров внутри каталога
  4. Получение карточки товара
  5. Работа с брендами и проектами

Все данные зависят от прав текущего пользователя.

🔐 Авторизация

Для работы с API используется JWT (Bearer Token).

Получение токена:

POST /auth/login

Пример запроса:

{
  "login": "user@example.com",
  "password": "your_password"
}

Использование токена:

Authorization: Bearer <token>

⚠️ Все методы (кроме авторизации) требуют токен.

📦 Формат ответа

Все ответы API имеют единый формат.

Успешный ответ

{
  "success": true,
  "data": {},
  "meta": {
    "timestamp": "2026-03-23T17:29:24+00:00"
  }
}

Ответ с ошибкой

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Описание ошибки"
  },
  "meta": {
    "timestamp": "2026-03-23T17:29:24+00:00"
  }
}

📚 Разделы API

🔐 Авторизация

Получение токена и информации о пользователе

🗂 Каталоги

Получение и навигация по каталогам

📦 Товары

Получение товаров и карточек

🏷 Бренды

Список доступных брендов

📁 Проекты

Работа с проектами

Авторизация

Методы авторизации и получения данных текущего пользователя

Авторизация

Авторизация пользователя и получение JWT токена

Request Body schema: application/json
required
login
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "login": "user@example.com",
  • "password": "secret"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": {
    }
}

Каталоги

Методы работы с каталогами

Список каталогов

Возвращает каталоги, доступные текущему пользователю

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Товары каталога

Возвращает товары выбранного каталога с пагинацией

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID каталога

query Parameters
page
integer
Default: 1

Номер страницы

limit
integer
Default: 20
Enum: 20 30 50

Количество элементов на странице

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": {
    }
}

Товары

Методы работы с товарами

Карточка товара

Возвращает детальную информацию о товаре

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

UUID товара

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {},
  • "meta": {
    }
}

Бренды

Методы работы с брендами

Список брендов

Возвращает бренды, доступные текущему пользователю

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": {
    }
}

Проекты

Методы работы с проектами

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

Возвращает проекты, доступные текущему пользователю

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {},
  • "meta": {
    },
  • "paths": null
}