Методы API
Список методов

ОСАГО

Добавить задачу на получение информации об ОСАГО по VIN/госномеру:

key
Ключ доступа к API
vin
VIN номер автомобиля
gosnumber
Госномер автомобиля

Результат вызова метода:

Описание возвращаемого JSON

start DateTime
Дата и время создание запроса
end DateTime
Дата и время окончания запроса
vin String
VIN номер по которому запрашивается информация
error Boolean
Признак ошибки в запросе, имеет значение true в случае ошибки и null в случае её отсутствия
id Int
ID возвращаемой задачи

Результат вызова метода в случае ошибки:

  • Закончился доступ или запросы (Проверить доступ)

  • Нет необходимых прав

  • Некорректный ключ доступа или пользователь не создан
  • Описание возвращаемого JSON

    start DateTime
    Дата и время создание запроса
    end DateTime
    Дата и время окончания запроса
    vin String
    VIN номер ТС по которому запрашивается информация
    gosnomer String
    Гос.номер ТС по которому запрашивается информация
    error Boolean
    Признак ошибки в запросе, имеет значение true в случае ошибки и null в случае её отсутствия
    error_msg String
    Сообщение с описанием ошибки

    Проверить статус готовности задачи:

    key
    Ключ доступа к API
    id
    идентификатор задачи
    addinfo
    флаг, активирующий одновременное получение дополнительных данных об автомобиле и полисе
  • Вызывать метод нужно с периодичностью от 1-5 секунд до тех пор, пока в ответном пакете status не примет значение complete или error.

  • Результат вызова метода:

    Описание возвращаемого JSON

    start DateTime
    Дата и время создание запроса
    end DateTime
    Дата и время окончания запроса
    vin String
    VIN номер по которому запрашивается информация
    error Boolean
    Признак ошибки в запросе, имеет значение true в случае ошибки и null в случае её отсутствия
    id Int
    ID задачи
    status String
    Статус выполнения задачи
    result String
    Результат выполнения задачи
    dt String
    Время запроса в unix формате

    Результат вызова метода в случае ошибки:

  • Когда задача еще не готова

  • Если не указан госномер или вин

  • В очереди слишком много задач

  • Не найдены данные для VIN/госномера
  • Описание возвращаемого JSON

    start DateTime
    Дата и время создание запроса
    end DateTime
    Дата и время окончания запроса
    id String
    ID задачи по которому запрашивается информация
    error Boolean
    Признак ошибки в запросе, имеет значение true в случае ошибки и null в случае её отсутствия
    error_msg String
    Сообщение с описанием ошибки