ВНИМАНИЕ / WARNING

Документация строго предназначена для разработчиков Senimen. Запрещается использование сторонними разработчиками. Любое несанкционированное использование API будет преследоваться.

This documentation is strictly intended for Senimen developers. Use by third-party developers is prohibited. Any unauthorized use of the API will be prosecuted.

Introduction

Добро пожаловать в документацию REST API платформы Senimen. Все ответы сервера приходят в едином формате. Сообщения (message) приходят на казахском языке для отображения в UI.

Welcome to the Senimen REST API documentation. All server responses follow a unified format. Messages (message) are returned in Kazakh for UI display.

Base URL: https://api.senimen.app

Response Format

Единый формат ответа для всех эндпоинтов. / Unified response format for all endpoints.

Unified Response Structure
{
  "success": boolean, // Статус выполнения / Success status
  "code": number,    // Код результата / Result code
  "message": string, // Сообщение (на казахском) / Message (in Kazakh)
  "data": any        // Данные (Array, Object, null, []) / Data
}
Code 0
Success
Успешное выполнение / Successful execution
Code 1
Business Error
Ошибка бизнес-логики / Business logic error
Code 2
Internal Error
Внутренняя ошибка сервера / Internal server error

Authentication

Для аутентификации используется Stateful Token. Токен должен передаваться в заголовке Authorization: Bearer <token>.

Stateful Token is used for authentication. The token must be passed in the Authorization: Bearer <token> header.

POST/auth/sign-in

Авторизация / Sign In

Вход в систему по email и паролю. / Login using email and password.

Request Body (JSON)
{
  "email": "user@example.com",
  "password": "password123"
}
Success Response (200 OK)
{
    "success": true,
    "code": 0,
    "message": "Жүйеге кіру сәтті орындалды",
    "data": {
        "id": 1,
        "token": "senimen.id.c93109f8c3303a87374efd951...",
        "role": 0
    }
}
Error Response (Code 1)
{
    "success": false,
    "code": 1,
    "message": "Электрондық пошта немесе құпиясөз дұрыс емес",
    "data": null
}
POST/auth/sign-up

Регистрация / Sign Up

Создание нового аккаунта. / Create a new account.

Request Body (JSON)
{
  "username": "qazaq_otaku",
  "email": "user@example.com",
  "password": "password123"
}
Success Response (200 OK)
{
    "success": true,
    "code": 0,
    "message": "Тіркелу сәтті аяқталды",
    "data": null
}
Error Response (Code 1)
{
    "success": false,
    "code": 1,
    "message": "Бұл электрондық пошта немесе қолданушы аты бұрыннан тіркелген",
    "data": null
}
POST/auth/verify

Подтверждение почты / Email Verification

Отправка и проверка кода подтверждения. / Sending and verifying the confirmation code.

Action: send (Отправка кода / Send code)

Request Body (JSON)
{
  "action": "send",
  "email": "user@example.com"
}
Success Response
{
    "success": true,
    "code": 0,
    "message": "Растау коды жіберілді",
    "data": null
}
Error Response (Cooldown)
{
    "success": false,
    "code": 1,
    "message": "Кодты қайта жіберу үшін 120 секунд күту қажет",
    "data": null
}

Action: verify (Проверка кода / Verify code)

Request Body (JSON)
{
  "action": "verify",
  "email": "user@example.com",
  "code": "123456"
}
Success Response
{
    "success": true,
    "code": 0,
    "message": "Электрондық пошта сәтті расталды",
    "data": null
}
Error Response (Invalid/Expired)
{
    "success": false,
    "code": 1,
    "message": "Растау коды жарамсыз немесе мерзімі аяқталды",
    "data": null
}
GET/auth/check

Проверка токена / Check Token

Проверка валидности токена. / Check if the token is valid.

Header: Authorization: Bearer <token>
Valid Token Response
{
    "success": true,
    "code": 0,
    "message": null,
    "data": {
        "is_valid": true
    }
}
Invalid Token Response
{
    "success": true,
    "code": 0,
    "message": null,
    "data": {
        "is_valid": false
    }
}