Проверка действительности паспорта
Для проверки действительности паспорта используйте следующий запрос:
https://parser-api.com/parser/passport_api/?key=ВАШ_КЛЮЧ_ДОСТУПА&passport_series=СЕРИЯ_ПАСПОРТА&passport_number=НОМЕР_ПАСПОРТА&first_name=ИМЯ&last_name=ФАМИЛИЯ
Параметры запроса:
- key — ключ доступа к сервису (обязательный).
- passport_series — серия паспорта (обязательный).
- passport_number — номер паспорта (обязательный).
- first_name — имя владельца паспорта (обязательный).
- last_name — фамилия владельца паспорта (обязательный).
Пример запроса:
https://parser-api.com/parser/passport_api/?key=ВАШ_КЛЮЧ_ДОСТУПА&passport_series=3914&passport_number=935349&first_name=Сергей&last_name=Здрилюк
Пример ответа на запрос:
Ответ на запрос возвращается в формате JSON. Пример ответа:
{
"success": 1, // Флаг успешности выполнения запроса. При получении 0 сделайте повторный запрос сразу же или через несколько минут.
"status": "VALID" // Статус паспорта, возможные значения: VALID - Действителен, NOT_VALID - Недействителен, NOT_FOUND - Не найден
}
Интерпретация ответа и обработка ошибок
Общие рекомендации:
- Если поле
success
заполнено и success = 1
— перед вами успешный ответ, с которым можно работать. Только такие запросы учитываются в статистике и расходуют оплаченный лимит.
- Иначе, если поле
error
заполнено — запрос требует вашего внимания. Текст ошибки рекомендуется сохранить или отправить для дальнейшего анализа.
- Иначе, если поле
error
не заполнено — это ошибка, связанная со стабильностью источника. В таком случае мы рекомендуем игнорировать ответ и повторить запрос.
В данном разделе описаны возможные коды ответов сервиса и их значения. Каждый код ответа сопровождается пояснением и примером JSON-ответа.
1. Код ответа - 200
Выдается сервисом в случае успешной валидации и успешной обработки запроса источником. Всегда сопровождается полем success = 1
в корне ответа. Именно такие и только такие запросы можно запускать в дальнейшую обработку.
2. Код ответа - 523
Выдается сервисом в случае успешной валидации и неуспешной обработки запроса источником. Связан с временными проблемами в работе источника, невозможностью получить информацию.
Пример ответа:
{
"success": 0
}
3. Код ответа - 403
Выдается сервисом в случае невозможности обработки запроса из-за ограничения доступа: закончилась подписка, превышен лимит и так далее. Причины ошибок отражены в поле error
ответа. Ниже приведен список возможных ошибок с их описанием и кодами:
- Invalid access key
error_code = 40301
Указанный ключ доступа недействителен или отсутствует.
- The subscription period has expired
error_code = 40302
Доступ к сервису истек, требуется продление.
- Invalid IP
error_code = 40303
Запрос выполнен с IP-адреса, который не разрешён для доступа.
- Day limit of requests exceeded
error_code = 40304
Достигнут оплаченный лимит запросов на день.
- Month limit of requests exceeded
error_code = 40305
Достигнут оплаченный лимит запросов на месяц.
Пример ответа:
{
"error": "Invalid access key",
"error_code": 40301
}
4. Код ответа - 400
Выдается сервисом в случае невозможности обработки запроса из-за ошибки валидации запроса, неверного или отсутствующего значения какого-либо поля. Поле error_code
всегда равно 40001
, подробности доступны в поле error
.
Пример ответа:
{
"error": "Missing first_name in input params",
"error_code": 40001
}