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

Методы API

Продуктовые методы

Реализация методов зависит от страхового продукта. Код продукта передается в параметрах пути запроса: cargo, casco, osago, mortgage, medical, property, gap, pet. Спецификации продуктовых сервисов

Заключение договора

POST /quotes - Предварительный расчет стоимости договора
Метод позволяет выполнить расчет премии по указанным в запросе параметрам и, в случае успеха, возвращает рассчитанную премию. При этом котировка не сохраняется в системе. Обычно для расчета премии достаточно минимального набора параметров
POST /policies - Итоговый расчет стоимости договора
Метод позволяет сохранить полный набор данных, выполнить расчет премии и в случае успеха возвращает сохранённый полис. Указанные в запросе данные проходят валидацию. Генерируется номер договора
PUT /policies - Обновить данные договора
Метод позволяет изменить ранее сохраненный полис, выполнить расчет премии. Указанные в запросе данные проходят валидацию. Метод доступен только для неоплаченных полисов
GET /policies - Получить данные по договору
Получение информация по договору страхования из Фабрики. Метод используется при пролонгации
POST /addendums - Создать дополнительное соглашение
Создает дополнительное соглашение к договору страхования

Оплата договора

PUT /installments - Задать метод оплаты для очередного взноса
Задать метод оплаты для очередного взноса
GET /installments - Получить информацию об очередном взносе
Получить информацию об очередном взносе

Файлы по договору

GET /files - Получить ПФ документа
Метод позволяет получить печатную форму документа по договору страхования. В запросе нужно указать номер договора и тип документа (POLICY - полис, BILL - счет). Документ будет передан в ответе в формате base64 (параметр policyPDF)

Общие методы

Данные методы имеют общую реализацию для всех продуктов

GET /operation - Получить статус операции
Метод возвращает информацию о последней операции по договору (заключение договора, оплата договора). Регистрация оплаты, формирование печатной формы может продолжаться в течение длительного периода времени. Ответ на каждый такой запрос содержит URL операции (параметр href). Используя его, можно получить информацию о последней операции (например, получить печатную форму полиса)
GET /policies - Получить документ
Метод позволяет получать информацию по договору