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

Сценарий оформления ОСАГО:

Авторизация:​

Авторизация происходит с помощью метода POST https://services-stg.vsk.ru/ship/token Где в body необходимо передать:

  • client_id = выдает СК при получении доступа к сервису
  • client_secret = выдает СК при получении доступа к сервису
  • grant_type = client_credentials (передавать всегда)

Подробное описание методов по ссылке.​

Swagger - https://app.swaggerhub.com/apis/insur/name Для ФЛ методы individual, для ЮЛ - corporate. Адрес сервера: Stage: https://services-stg.vsk.ru/ship/biz/ Prod: https://services.vsk.ru/ship/biz/

Общий сценарий работы для ФЛ:​

  1. Аутентификация, согласно описанию: https://developers.vsk.ru/docs/auth/. Получение токена доступа для вызова методов.
  2. Возможно асинхронное выполнение запросов, для этого в любом из методов запроса, необходимо в Headers передать тег desired-timeout и установить для него значение в секундах. Рекомендую установить значение для любого запроса 59 000 миллисекунд. Если сервис не успеет ответить за переданное в параметре desired-timeout время, то в ответе вернется следующее сообщение:
{
    "draftId": "23f2792e-5396-446b-b279-2e5396846b8b",
    "method": "GET",
    "href": "/sales/v2/operations?oper_id=23f2792e-5396-446b-b279-2e5396846b8b"
}

Далее необходимо перейти к пункту 6 и методу operations.

  1. Предварительный расчет стоимости договора (POST {{server}}/sales/v2/individual/osago/quotes). Быстрый расчет премии по договору. Для того, чтобы премия на предварительном расчете соответствовала премии при создании договора, необходимо передавать те же данные, которые требуются при создании проекта договора.
  2. Создание проекта договора, итоговый расчет стоимости договора (POST {{server}}//sales/v2/individual/osago/policies). Сохраняется проект договора, присваивается номер.
  3. При необходимости можно обновить сохраненные данные в созданном ранее договоре (PUT {{server}}//sales/v2/individual/osago/policies/{{policyNumber}}).
  4. Для вызова результата ранее вызванного асинхронного запроса, необходимо вызвать метод operations (GET {{server}}+ href из ответа на асинхронных вызов, например: {{server}}/sales/v2/operations?oper_id=23f2792e-5396-446b-b279-2e5396846b8b). При положительном результате отработки ранее вызванного асинхронного метода будет возвращен ответ с данными, или текст ошибки. Так же возможен ответ ошибкой 404 Not Found. Данная ошибка может возникать в двух случаях:
  • 6.1. Ранее вызванный асинхронный метод еще не отработал, поэтому для метода предрасчета (POST …/quotes) вызов метода GET operations желательно установить время вызова не ранее чем через минуту, для метода создания договора (POST …/ policies) вызов метода operations не ранее чем через 120 000 миллисекунд после получения ссылки.
  • 6.2. Если прошло указанное в пункте 6.1 время, а ответ на запрос метода operations возвращается ошибка 404 Not Found, значит есть технический сбой в системе и необходимо обратиться в службу технической поддержки интеграционного сервиса ВСК.
  1. При необходимости можно получить печатную форму: черновика, полиса, счета. Для этого требуется вызвать метод (GET {{server}}/sales/v2/policies//{{policyNumber}}/files/{{filestype}}), где filestype это тип печатной формы. Существуют несколько типов печатной формы: BILL – счет; DRAFT – черновик полиса; POLICY – финальная печатная форма полиса.
  2. Если требуется получить данные по ранее созданному полису, то необходимо вызвать метод получения данных по созданному ранее полису (GET {{server}}/sales/v2/individual/osago/policies///{{policyNumber}}) (Важно, что получение данных возможно только по договорам оформленных в этой интеграции)
  3. Оплата полиса производится вызовом метода installments (PUT {{server}}//sales/v2/individual/osago/policies/{{policyNumber}}//installments/1) обязательность полей в body зависит от типа переданного значения "paymentType", существуют следующие значения: CASH: оплата наличными в кассу партнера; CASHLESS – Выставление счета на оплату в сторону ВСК (лучше такой способ не использовать для ФЛ); CARD - оплата картой по ссылке для клиента; SBP – оплата по ссылке через СБП)

Общий сценарий работы для ЮЛ( В том числе Лизинг):​

  1. Аутентификация, согласно описанию: https://developers.vsk.ru/docs/auth/. Получение токена доступа для вызова методов.
  2. Возможно асинхронное выполнение запросов, для этого в любом из методов запроса, необходимо в Headers передать тег desired-timeout и установить для него значение в секундах. Рекомендую установить значение для любого запроса 59 000 миллисекунд. Если сервис не успеет ответить за переданное в параметре desired-timeout время, то в ответе вернется следующее сообщение:
{
    "draftId": "23f2792e-5396-446b-b279-2e5396846b8b",
    "method": "GET",
    "href": "/sales/v2/operations?oper_id=23f2792e-5396-446b-b279-2e5396846b8b"
}

Далее необходимо перейти к пункту 6 и методу operations.

  1. Предварительный расчет стоимости договора (POST {{server}}/sales/v2/corporate/osago/quotes). Быстрый расчет премии по договору. Для того, чтобы премия на предварительном расчете соответствовала премии при создании договора, необходимо передавать те же данные, которые требуются при создании проекта договора.
  2. Создание проекта договора, итоговый расчет стоимости договора (POST {{server}}//sales/v2/corporate/osago/policies). Сохраняется проект договора, присваивается номер.
  3. При необходимости можно обновить сохраненные данные в созданном ранее договоре (PUT {{server}}//sales/v2/corporate/osago/policies/{{policyNumber}}).
  4. Для вызова результата ранее вызванного асинхронного запроса, необходимо вызвать метод operations (GET {{server}}+ href из ответа на асинхронных вызов, например: {{server}}/sales/v2/operations?oper_id=23f2792e-5396-446b-b279-2e5396846b8b). При положительном результате отработки ранее вызванного асинхронного метода будет возвращен ответ с данными, или текст ошибки. Так же возможен ответ ошибкой 404 Not Found. Данная ошибка может возникать в двух случаях:
  • 6.1. Ранее вызванный асинхронный метод еще не отработал, поэтому для метода предрасчета (POST …/quotes) вызов метода GET operations желательно установить время вызова не ранее чем через минуту, для метода создания договора (POST …/ policies) вызов метода operations не ранее чем через 120 000 миллисекунд после получения ссылки.
  • 6.2. Если прошло указанное в пункте 6.1 время, а ответ на запрос метода operations возвращается ошибка 404 Not Found, значит есть технический сбой в системе и необходимо обратиться в службу технической поддержки интеграционного сервиса ВСК.
  1. При необходимости можно получить печатную форму: черновика, полиса, счета. Для этого требуется вызвать метод (GET {{server}}/sales/v2/policies//{{policyNumber}}/files/{{filestype}}), где filestype это тип печатной формы. Существуют несколько типов печатной формы: BILL – счет; DRAFT – черновик полиса; POLICY – финальная печатная форма полиса.
  2. Если требуется получить данные по ранее созданному полису, то необходимо вызвать метод получения данных по созданному ранее полису (GET {{server}}/sales/v2/corporate/osago/policies///{{policyNumber}}) (Важно, что получение данных возможно только по договорам оформленных в этой интеграции)
  3. Оплата полиса производится вызовом метода installments (PUT {{server}}//sales/v2/corporate/osago/policies/{{policyNumber}}//installments/1) обязательность полей в body зависит от типа переданного значения "paymentType", существуют следующие значения: CASH: оплата клиентом на счет партнера; CASHLESS – Выставление счета на оплату в сторону ВСК (договор активируется только после квитования дережных средств на счере ВСК);