Перейти к основному содержимому

Песочница Mandarin.ID

Песочница Mandarin.ID — это тестовое окружение для проверки интеграции перед запуском в рабочем режиме.

В песочнице можно отправить тестовые запросы, проверить авторизацию, передачу SMS-кода, получение статуса идентификации и обработку ошибок.

Как получить доступ к песочнице​

Чтобы подключить Mandarin.ID на тестовом проекте, обратитесь в службу технической поддержки Mandarin.

Для работы с песочницей нужны:

  • проект в статусе «Песочница»;
  • подключенный продукт Mandarin.ID;
  • тестовые данные проекта для авторизации запросов.

Статус проекта можно проверить в личном кабинете: Настройки → Общие настройки проекта.

Какие параметры использовать​

Для тестового окружения Mandarin.ID используются те же параметры запроса, что и для рабочего окружения.

Аутентификация запросов выполняется через заголовок X-Auth.

Также доступна авторизация через Basic auth.

Для авторизации используйте данные тестового проекта, на котором подключен продукт Mandarin.ID.

Подробнее об аутентификации запросов

Как работает SMS-код в песочнице​

В тестовом окружении SMS с кодом подтверждения не отправляется.

Для подтверждения номера используйте код:

000000

В некоторых проектах длина SMS-кода может отличаться. Если у вас настроена другая длина кода, используйте соответствующее количество нулей.

Как получить успешный результат проверки​

Чтобы в песочнице получить результат:

"personVerified": true

передайте следующие ФИО:

{
  "firstName": "Полиграф",
  "lastName": "Шариков",
  "patronymic": "Полиграфович"
}

Если передать другие ФИО, в ответе будет:

"personVerified": false

Важно: даже в тестовом окружении нужно передавать паспортные данные и другие обязательные параметры согласно документации. В песочнице результат проверки определяется по ФИО.

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

Запрос на идентификацию по СНИЛС​

POST https://secure.mandarinpay.com/api/personidentification
{
  "firstName": "Полиграф",
  "lastName": "Шариков",
  "patronymic": "Полиграфович",
  "passportSeries": "1111",
  "passportNumber": "111111",
  "snils": "19033603123",
  "phone": "+79506236517"
}

Запрос на идентификацию по ИНН​

Для запроса по ИНН параметр snils также обязателен. В этом случае передайте пустое значение:

"snils": ""

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

POST https://secure.mandarinpay.com/api/personidentification
{
  "firstName": "Полиграф",
  "lastName": "Шариков",
  "patronymic": "Полиграфович",
  "passportSeries": "1111",
  "passportNumber": "111111",
  "snils": "",
  "inn": "501716749325",
  "phone": "+79506122517"
}

Ответ при успешном создании запроса:

{
  "id": "794d3cc7-a2b4-4579-9173-bafc7d7dc29d"
}

Передача SMS-кода​

После создания запроса передайте SMS-код на проверку.

PUT https://secure.mandarinpay.com/api/personidentification/{id}
{
  "smsCode": "000000"
}

Ответ при успешной передаче кода:

{
  "id": "794d3cc7-a2b4-4579-9173-bafc7d7dc29d"
}

Получение статуса идентификации​

Чтобы получить результат проверки, отправьте запрос статуса:

GET https://secure.mandarinpay.com/api/personidentification/{id}

Пример: проверка персональных данных завершена, SMS-код еще не передан​

{
  "id": "485fc237-a8b8-45f9-816d-fb7de3715e2b",
  "phoneVerified": null,
  "phoneVerificationFinished": false,
  "personVerified": true,
  "personVerificationFinished": true,
  "personVerificationError": "Sandbox mode"
}

Такой ответ означает, что переданы тестовые ФИО Шариков Полиграф Полиграфович, поэтому персональные данные успешно проверены. При этом SMS-код еще не был передан.

Пример: проверка персональных данных и телефона завершена​

{
  "id": "485fc237-a8b8-45f9-816d-fb7de3715e2b",
  "phoneVerified": true,
  "phoneVerificationFinished": true,
  "personVerified": true,
  "personVerificationFinished": true,
  "personVerificationError": "Sandbox mode"
}

Такой ответ означает, что переданы тестовые ФИО и SMS-код успешно подтвержден.

Пример: персональные данные не прошли проверку​

{
  "id": "d3552b7c-80a6-4e0e-bf1f-ad0c7ff2d705",
  "phoneVerified": true,
  "phoneVerificationFinished": true,
  "personVerified": false,
  "personVerificationFinished": true,
  "personVerificationError": "Sandbox mode"
}

Такой ответ означает, что были переданы ФИО, отличные от тестовых. SMS-код при этом подтвержден.

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

Ошибка 401​

{
  "error": "Authentication error: "
}

Причина: запрос не прошел авторизацию.

Что сделать: проверьте данные тестового проекта и способ авторизации — X-Auth или Basic auth.

Подробнее об аутентификации запросов

Ошибка 400: не указан ID сессии​

{
  "sessionId": [
    "The value '{id}\n' is not valid."
  ]
}

Причина: в запросе статуса идентификации не указан корректный id.

Что сделать: проверьте, что в URL передан ID, полученный при создании запроса.

Ошибка 400: не указан snils​

{
  "snils": [
    "Required property 'snils' not found in JSON. Path '', line 9, position 1."
  ]
}

Причина: в запросе на идентификацию не передан параметр snils.

Что сделать: добавьте snils в тело запроса. Если идентификация выполняется по ИНН, передайте snils с пустым значением.

Ошибка 400: неверный формат snils​

{
  "snils": [
    "The field Snils must match the regular expression '[0-9]{11}'."
  ]
}

Причина: параметр snils содержит недопустимые символы или не соответствует формату.

Что сделать: передайте СНИЛС в формате 11 цифр без пробелов, дефисов и других символов.

Ошибки 5xx​

Причина: ошибка на стороне сервера.

Что сделать: повторите запрос позже. Если ошибка повторяется, обратитесь в службу поддержки Mandarin и передайте текст ошибки, время запроса и ID проекта.

Нужна помощь​

Если не получается подключить песочницу или запросы возвращают ошибку, обратитесь в службу поддержки Mandarin.

Перед обращением подготовьте:

  • CID / ClientID проекта;
  • время отправки запроса;
  • полный текст ошибки;
  • пример запроса без чувствительных данных.

Содержание

Подключите Mandarin.ID