## Документация API проверки электронных паспортов транспортных средств (ЭПТС) ### Проверка наличия электронного ПТС Для проверки наличия электронного паспорта транспортного средства используйте следующий запрос: ``` https://service.api-assist.com/parser/elpts_api/?key=ВАШ_КЛЮЧ_ДОСТУПА&vin=VIN_НОМЕР ``` или ``` https://service.api-assist.com/parser/elpts_api/?key=ВАШ_КЛЮЧ_ДОСТУПА&pts=НОМЕР_ПТС ``` **Параметры запроса:** - **key** — ключ доступа к сервису (обязательный). - **vin** — VIN номер транспортного средства (обязательный, если не указан pts). - **pts** — номер ПТС (обязательный, если не указан vin). **Пример запроса по VIN:** ``` https://service.api-assist.com/parser/elpts_api/?key=ВАШ_КЛЮЧ_ДОСТУПА&vin=XKN0A1000L1000003 ``` **Пример запроса по номеру ПТС:** ``` https://service.api-assist.com/parser/elpts_api/?key=ВАШ_КЛЮЧ_ДОСТУПА&pts=164301036658858 ``` **Пример ответа на запрос:** Ответ на запрос возвращается в формате JSON. Пример ответа: ```json { "success": 1, // Флаг успешности выполнения запроса. При получении 0 сделайте повторный запрос сразу же или через несколько минут. "found": 1, // Существует или нет электронный ПТС. 1 - найден, 0 - не найден "status": "действующий", // Статус электронного ПТС "records": [ { "country": "Российская Федерация", // Страна "type": "Электронный паспорт транспортного средства", // Вид электронного паспорта "displosal_fee": "РФ уплачен", // Сведения об уплате утилизационного сбора "restrictions_status": "отсутствуют", // Ограничения (обременения) за исключением таможенных "customs_restrictions_status": "отсутствуют", // Таможенные ограничения "last_reg_action": "РФ - Постановка на регистрационный учет (23.11.2020)", // Сведения о последнем регистрационном действии "production": "РФ - Выпуск в свободное обращение (01.12.2020)" // Сведения о выпуске (таможенное оформление) } ] } ``` --- ### Интерпретация ответа и обработка ошибок **Общие рекомендации:** - Если поле `success` заполнено и `success = 1` — перед вами успешный ответ, с которым можно работать. Только такие запросы учитываются в статистике и расходуют оплаченный лимит. - Иначе, если поле `error` заполнено — запрос требует вашего внимания. Текст ошибки рекомендуется сохранить или отправить для дальнейшего анализа. - Иначе, если поле `error` не заполнено — это ошибка, связанная со стабильностью источника. В таком случае мы рекомендуем игнорировать ответ и повторить запрос. В данном разделе описаны возможные коды ответов сервиса и их значения. Каждый код ответа сопровождается пояснением и примером JSON-ответа. #### 1. Код ответа - 200 - Поле `success = 1` - удалось получить информацию от источника. Такие и только такие запросы можно запускать в дальнейшую обработку. - Поле `success = 0` - не удалось получить информацию от источника. Запрос не будет учтен в статистике. Необходимо повторить запрос. #### 2. Код ответа - 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` Достигнут оплаченный лимит запросов на месяц. **Пример ответа:** ```json { "error": "Invalid access key", "error_code": 40301 } ``` #### 3. Код ответа - 400 Выдается сервисом в случае невозможности обработки запроса из-за ошибки валидации запроса, неверного или отсутствующего значения какого-либо поля. Поле `error_code` всегда равно `40000`, подробности доступны в поле `error`. **Пример ответа:** ```json { "error": "VIN or pts is required", "error_code": 40000 } ```