Обзор

REST JSON API для мобильного приложения IPR SMART. Совместим по маршрутам и формату ответов с legacy old-mobible-api, работает с базой данных ipr_smart.

Установка и запуск

composer install
cp .env.example .env        # Windows: copy .env.example .env
php artisan key:generate

Настройте .env (см. раздел ниже), затем:

php artisan serve
# → http://localhost:8000

Для production: document root указывает на каталог public/. CI деплоит на mobile2.iprbookshop.ru (master) и mobile.dev.iprbookshop.ru (develop).

Переменные окружения

Для MariaDB/MySQL 5.7 в OSPanel укажите DB_COLLATION=utf8mb4_unicode_ci (MySQL 8 collation utf8mb4_0900_ai_ci не поддерживается).

Заголовки и версии API

Почти все запросы обязаны содержать заголовок:

VERSION-API: 3

Исключение: GET /oauth — заголовок не требуется (как в old-mobible-api).

Авторизация

Публичные маршруты (с VERSION-API)

Параметры uid / deviceId / accessToken не нужны:

• POST /users/auth
• GET /users/status
• GET /users/check
• GET /users/restore
• POST /users/create

Без VERSION-API

• GET /oauth

Защищённые маршруты

Middleware ApiAccess проверяет следующие параметры (query string или body):

Формула токена доступа

Поток авторизации

Пароли при входе

• Принимается только формат приложения: md5(md5(plain) + MOBILE_AUTH_SALT)
• Legacy MD5 в БД → сравнивается с md5(хранимый_md5 + соль)
• Bcrypt в БД → хеш приложения сверяется с сохранённым верификатором (регистрация, восстановление пароля)

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

v3 (VERSION-API: 3)

{
  "meta": { "success": true, "message": "" },
  "data": { ... }
}

Ошибка:

{
  "meta": { "success": false, "message": "Текст ошибки" },
  "data": null
}

Legacy (VERSION-API: 1–2)

{ "success": "true", "message": "", ... }
{ "success": "false", "message": "Текст ошибки" }

Авторизация (POST /users/auth) при legacy оборачивает данные в ключ user:

{
  "success": "true",
  "message": "",
  "user": {
    "username": "...", "uid": 123, "accessToken": "...",
    "cid": 45, "fullname": "...", "org_name": "..."
  }
}

Исключения из общих правил

Пагинация

{
  "meta": { "success": true, "message": "" },
  "data": {
    "total": 100,
    "per_page": 50,
    "current_page": 1,
    "last_page": 2,
    "next_page_url": "...",
    "prev_page_url": null,
    "from": 1,
    "to": 50,
    "data": [ ... ]
  }
}

Исключение: GET /users/status всегда возвращает legacy-формат независимо от версии API (см. таблицу выше).

Совместимость с old-mobible-api

API реализован как замена legacy old-mobible-api с сохранением маршрутов, имён полей (pagetitle, tv_*) и форматов ответов.

Сводка по группам маршрутов

Значения selection_options (каталог книг)

Пользователи

{
  "meta": { "success": true, "message": "" },
  "data": {
    "username": "user@example.com",
    "uid": 123,
    "cid": 45,
    "fullname": "Иванов И.И.",
    "org_name": "Университет",
    "email": "user@example.com",
    "blockedAfter": 1735689600,
    "blockedHash": "abc...",
    "accessToken": "device_token_from_db",
    "clientLogotype": "https://...",
    "clientColor": "ff9900"
  }
}

{
  "success": "true",
  "message": "",
  "version": { "version": 13, "strong": true },
  "username": "Иванов И.И.",
  "org_name": "Университет",
  "clientLogotype": "https://...",
  "clientColor": "ff9900"
}

Книги

Все маршруты защищённые. Канонический путь: /v3/books/...

Журналы

Номера журналов

Поиск

Избранное

Тип публикации: type=1 — книга, type=2 — журнал или номер. Если type не указан, тип определяется по ID.

listId[]=123&listId[]=456&uid=123
→ { "success": "true", "message": "Издания успешно добавлены!" }

{
  "uploads": [
    { "id": 123, "type": 1, "action": "add" },
    { "id": 456, "type": 2, "action": "delete" }
  ]
}

Цитаты, закладки, контент, рейтинг

Маршруты на уровне корня (не внутри /books/). {id} — ID публикации (книги).

{
  "meta": { "success": true, "message": "" },
  "data": { "value": 4.5, "user_value": 5 }
}

Примеры запросов

1. Авторизация

passwd — не открытый пароль, а md5(md5(plain) + MOBILE_AUTH_SALT):

curl -X POST "http://localhost:8000/users/auth" \
  -H "VERSION-API: 3" \
  -d "username=user@example.com" \
  -d "passwd=COMPUTED_ANDROID_HASH" \
  -d "device_id=my-device-001"

2. Вычисление токена (PHP)

$salt = 'Ga90IfDBzo2Mqcva';       // MOBILE_AUTH_SALT
$deviceToken = '...';              // accessToken из ответа auth
$deviceId = 'my-device-001';
$date = date('Ymd');

$token = md5($salt . $deviceToken . $deviceId . $date);

3. Каталог книг

curl "http://localhost:8000/v3/books/catalog?page=1&uid=123&deviceId=my-device-001&accessToken=COMPUTED_TOKEN&date=20250714" \
  -H "VERSION-API: 3"

4. Карточка книги

curl "http://localhost:8000/v3/books/42?uid=123&deviceId=my-device-001&accessToken=COMPUTED_TOKEN" \
  -H "VERSION-API: 3"

5. Поиск

curl "http://localhost:8000/v3/search?s=математика&type=1&page=1&uid=123&deviceId=my-device-001&accessToken=COMPUTED_TOKEN" \
  -H "VERSION-API: 3"

6. Добавить в избранное

curl -X PUT "http://localhost:8000/favorite/42?type=1&uid=123&deviceId=my-device-001&accessToken=COMPUTED_TOKEN" \
  -H "VERSION-API: 3"

7. Синхронизация избранного (legacy listId)

curl -X POST "http://localhost:8000/favorite/uploads" \
  -H "VERSION-API: 3" \
  -d "listId[]=42&listId[]=43&uid=123&deviceId=my-device-001&accessToken=COMPUTED_TOKEN"

8. OAuth (без VERSION-API)

curl "http://localhost:8000/oauth?username=user&password=secret&time=1234567890&hash=COMPUTED_HASH"

Типичные ошибки

IPR SMART Mobile API · Laravel 11.56.1 · Совместимость с old-mobible-api