Авторизация

Параметры запроса

• phone — номер телефона контрагента

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

{
    "phone": "79999999990"
}

Ответ

При успешном действии возвращается HTTP код 200.

{
    "message": "Password successfully send"
}

Описание полей ответа

• message — информационное сообщение об успешном выполнении операции

Параметры запроса

• phone — номер телефона контрагента
• password — последние 4 цифры номера телефона, с которого был совершён звонок-сброс (в примере ниже — условный 1111)

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

{
    "phone": "79999999990",
    "password": "1111"
}

Ответ

При успешном действии возвращается HTTP код 200.

{
    "counterparty": {
        "id": 1,
        "type": {
            "id": 2,
            "name": "Розница",
            "created_at": "2024-03-23T10:27:06.000000Z"
        },
        "manager": {
            "id": 1,
            "first_name": "Артём",
            "last_name": "Полищук",
            "middle_name": "Николаевич",
            "name": "Полищук Артём"
        },
        "avatar": null,
        "first_name": "Алексей",
        "last_name": "Петров",
        "middle_name": "Викторович",
        "birthday": "1980-04-02",
        "address": "630073, Новосибирская область, город Новосибирск, Новогодняя ул., д. 20/1, кв. 26",
        "phone_1": "79999999990",
        "phone_2": "78888888888",
        "email": "support@itecho.ru",
        "created_at": "2024-03-22T14:01:37.000000Z",
        "updated_at": "2024-03-23T10:48:33.000000Z",
        "access_token": {
            "value": "2|k8InFzsVIDB3sumslYax1hWJcZDglKptEgIWzxWo21bdb3d6"
        }
    }
}

Описание полей ответа

• id — первичный ключ
• type — объект с информацией о типе контрагента
  • id — идентификатор типа
  • name — название типа
  • created_at — дата создания
• manager — объект с информацией о менеджере
  • id — идентификатор менеджера
  • first_name — имя менеджера
  • last_name — фамилия менеджера
  • middle_name — отчество менеджера
  • name — полное имя менеджера
• avatar — аватар пользователя
• first_name — имя контрагента
• last_name — фамилия контрагента
• middle_name — отчество контрагента
• birthday — дата рождения
• address — адрес
• phone_1 — основной номер телефона
• phone_2 — дополнительный номер телефона
• email — электронная почта
• created_at — дата создания
• updated_at — дата последнего обновления
• access_token.value — Bearer token для авторизации в системе

Используется, когда miniapp уже получил у провайдера подтверждённый контакт клиента и должен получить обычный counterparty.access_token.value для E-Commerce API.

Канонический маршрут находится в counterparty-контуре. Не используйте публичные alias URL вида /api/miniapps/.../auth/....

Параметры пути

• provider — провайдер miniapp. Сейчас поддерживается max.

Параметры запроса

• phone (string, обязательно) — телефон из подписанного contact payload. Можно передать в формате +79139277802, в базе он сохранится как 79139277802.
• auth_date (integer, обязательно) — Unix timestamp подписи.
• hash (string, обязательно) — подпись contact payload, 64 hex-символа.
• init_data (string, обязательно) — подписанные init data miniapp.
• device (string, необязательно) — имя устройства для Sanctum token, например max-miniapp.

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

{
    "phone": "+79139277802",
    "auth_date": 1780000000,
    "hash": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
    "init_data": "auth_date=1780000000&user=%7B%22id%22%3A123456%7D&hash=...",
    "device": "max-miniapp"
}

Ответ

При успешном действии возвращается HTTP код 200 с объектом контрагента и access_token (аналогично POST /api/counterparty/login).

{
    "counterparty": {
        "id": 1,
        "phone_1": "79139277802",
        "access_token": {
            "value": "2|k8InFzsVIDB3sumslYax1hWJcZDglKptEgIWzxWo21bdb3d6"
        }
    }
}

Возможные ошибки

• 401 Application token is missing — не передан заголовок Token.
• 401 miniapp_contact_auth_invalid — подпись, init_data или срок действия не прошли проверку.
• 422 miniapp_contact_auth_not_supported — provider не поддерживает безопасный signed contact login, например Telegram без proof владения телефоном.
• 503 miniapp_contact_auth_not_configured — на backend не настроен token провайдера.

Параметры запроса

• from_all_devices — признак выхода со всех устройств (boolean)

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

{
    "from_all_devices": true
}

Ответ

При успешном действии возвращается HTTP код 200.

{
    "message": "User successfully logout from all devices"
}

Запускает звонок на номер телефона контрагента для авторизации по callback.

Параметры запроса

• phone (string, обязательно) — номер телефона контрагента

Ответ

При успешном действии возвращается HTTP код 200 с информацией о запущенном звонке.

Проверяет, завершён ли callback-звонок, и возвращает access_token если авторизация прошла успешно.

Параметры запроса

• phone (string, обязательно) — номер телефона контрагента

Ответ

При успешном действии возвращается HTTP код 200 с объектом контрагента и access_token (аналогично POST /api/counterparty/login).