Аутентификация по ссылке из рассылки

Описание метода

Метод позволяет автоматически авторизовать клиента на сайте при переходе по персональной ссылке из рассылки.

Как это работает:

• В рассылке формируется персональная ссылка с тикетом аутентификации
• Клиент переходит по ссылке на сайт
• Сайт извлекает тикет из URL и отправляет запрос в Mindbox API
• Mindbox проверяет тикет и возвращает данные клиента, если тикет корректен
• Сайт авторизует клиента на основе полученных данных

Предварительная настройка

Перед началом интеграции убедитесь, что:

1. Создана операция в Mindbox со следующими шагами:

   • Клиент — Авторизованный — Получить существующего по тикету
   • Клиент — Получить данные по текущему клиенту (настройте нужные поля для возврата)

   Подробнее о создании операций.

2. Настроена ссылка перехода в рассылки с использованием тикета. Например универсальный тикет на 5 минут: https://example.com/auth?ticket=${Ticket.UniversalAuthenticationCustomizableTimeTicket(5)}

Формат запроса

URL и параметры

POST https://api.mindbox.ru/v3/operations/sync?endpointId={Идентификатор точки интеграции}&operation={Название операции}&deviceUUID={Уникальный идентификатор устройства}

Заголовки

Тело запроса

Code
{
  "customer": {
    "authenticationTicket": "<Тикет аутентификации клиента из ссылки>"
  }
}

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

Code
POST https://api.mindbox.ru/v3/operations/sync?endpointId=MindboxRu&operation=AuthenticateByTicket&deviceUUID=550e8400-e29b-41d4-a716-446655440000

Content-Type: application/json; charset=utf-8
Accept: application/json
Authorization: SecretKey {Секретный ключ}

{
  "customer": {
    "authenticationTicket": "YwQzgwMDY5Q0IwNEE5RDNFRDAyMzRBQTE4NTZCMkVENzAyNzE1MCIgc2lnbmF0dXJlPSJFREVEMkE2NzNDQjAwMEY1MTNGQzBGN0Q0NkY0NTY2MjRGMThCNjVCRUE5REM4MDMxRUJDNTZBOTJBODdGN0JBOTZBOTJBQzk3NjRBNjBGRURCNjYwRjAzRkY0NDgyMzkxMjI5MkI4NDhENEZGQTUwRDExODA2NjAwMkVCOTlBMSIgLz"
  }
}

Пример ответа

Корректный тикет

При передаче валидного тикета API возвращает данные клиента:

Code
{
  "status": "Success",
  "customer": {
      "firstName": "Иван",
      "lastName": "Петров",
      "email": "test@example.com",
      "isEmailInvalid": false,
      "mobilePhone": 79991234567,
      "isMobilePhoneInvalid": false,
      "ids": {
        "mindboxId": 12345,
        "websiteID": "user-67890"
      },
      "changeDateTimeUtc": "2026-02-19T08:21:29.54Z"
  }
}

Некорректный или просроченный тикет

При передаче невалидного тикета API возвращает ответ без данных клиента:

Code
{
  "status": "Success"
}

Обработка ошибок

ProtocolError

Ошибка возникает при передаче пустого значения authenticationTicket:

Code
{
  "status": "ProtocolError",
  "errorMessage": "/customer/authenticationTicket: Поле должно быть заполнено.",
  "errorId": "<Идентификатор ошибки. Может отсутствовать>",
  "httpStatusCode": 400
}

Обработка результата на сайте

После получения ответа от API:

1. Проверьте статус ответа (status)
2. Проверьте наличие узла customer в ответе
3. Если данные клиента получены — авторизуйте клиента на сайте
4. Если данные клиента отсутствуют — перенаправьте на страницу входа

Конкретная реализация зависит от особенностей вашей интеграции.

Связанные материалы

• Аутентификация по паролю
• Аутентификация по секретному коду
• Типы тикетов аутентификации