Здесь показаны различия между двумя версиями данной страницы.
Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
api_страхование [2019/07/03 06:47] ilya |
api_страхование [2021/03/13 10:47] (текущий) butov |
||
---|---|---|---|
Строка 1: | Строка 1: | ||
- | ====== Описание выписки медицинских страховок HI API. ====== | + | ====== Описание использования HI API (страхование). ====== |
===== Как использовать API. ===== | ===== Как использовать API. ===== | ||
- | Все вызовы методов API — это GET или POST HTTP-запросы к URL https://192.168.93.240:8080/svd/handler/hi. с некоторым набором параметров. | + | Все вызовы методов API — это GET или POST HTTP-запросы по URL с некоторым набором параметров. |
==== Методы ==== | ==== Методы ==== | ||
Строка 21: | Строка 21: | ||
</request> | </request> | ||
- | Данные транзакции для ответа: | + | **Данные транзакции для ответа:** |
+ | |||
|<country>|описание страны| | |<country>|описание страны| | ||
|атрибут id|идентификационный номер страны| | |атрибут id|идентификационный номер страны| | ||
Строка 47: | Строка 48: | ||
</transaction> | </transaction> | ||
</response> | </response> | ||
- | method=load.insurance_amounts - Возвращает список сумм страхования для конкретной страны с учетом валюты, доступных на данный момент. Значение типа транзакции для запроса – dictionary_list. | + | method=load.insurance_amounts - Возвращает список сумм страхования для конкретной страны с учетом валюты, доступных на данный момент. Значение типа транзакции для запроса – dictionary_list. |
+ | |||
+ | **Данные транзакции для запроса:** | ||
- | Данные транзакции для запроса: | + | |<country> - идентификационный номер страны, взятый из списка, полученного в методе load.countries.| |
- | <country> - идентификационный номер страны, взятый из списка, полученного в методе load.countries. | + | |
XML формат запроса: | XML формат запроса: | ||
Строка 62: | Строка 64: | ||
</request> | </request> | ||
- | Данные транзакции для ответа: | + | ** Данные транзакции для ответа:** |
- | <amount> – описание суммы; | + | |<amount>|описание суммы| |
- | атрибут id – идентификационный номер суммы; | + | |атрибут id|идентификационный номер суммы| |
- | атрибут name – название суммы с учетом идентификатора валюты. | + | |атрибут name|название суммы с учетом идентификатора валюты| |
- | ==== XML формат ответа: ==== | + | **XML формат ответа:** |
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
Строка 81: | Строка 83: | ||
</response> | </response> | ||
| | ||
- | === Вычисление страховки === | + | ==== Вычисление страховки ==== |
- | method=insurance.calculate - Вычисляет стоимость страховки исходя из заданных параметров. Значение типа транзакции для запроса – calculate. | + | __method=insurance.calculate - Вычисляет стоимость страховки исходя из заданных параметров. Значение типа транзакции для запроса – calculate.__ |
- | == Данные транзакции для запроса: == | + | **Данные транзакции для запроса:** |
<country> - идентификационный номер страны, взятый из списка, полученного в методе load.countries; | <country> - идентификационный номер страны, взятый из списка, полученного в методе load.countries; | ||
Строка 93: | Строка 95: | ||
<purposes> - список занятий, которыми будут заниматься застрахованные лица. Формируется как побитовая маска (уточняем для конкретного документа). | <purposes> - список занятий, которыми будут заниматься застрахованные лица. Формируется как побитовая маска (уточняем для конкретного документа). | ||
- | XML формат запроса: | + | **XML формат запроса:** |
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<request version="1.0"> | <request version="1.0"> | ||
Строка 105: | Строка 107: | ||
<purposes>0</purposes> | <purposes>0</purposes> | ||
</transaction> | </transaction> | ||
- | </request> | + | </request> |
- | ==== Данные транзакции для ответа: ==== | + | **Данные транзакции для ответа:** |
|<programs>|список программ страхования| | |<programs>|список программ страхования| | ||
Строка 120: | Строка 122: | ||
|атрибут ratio|коэффициент для умножения тарифа страхования| | |атрибут ratio|коэффициент для умножения тарифа страхования| | ||
- | XML формат ответа: | + | **XML формат ответа:** |
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<response> | <response> | ||
Строка 140: | Строка 142: | ||
</response> | </response> | ||
- | Запись страховки | + | ==== Запись страховки ==== |
- | method=insurance.save – Записывает документ страховки в базу. Значение типа транзакции для запроса – save. | + | |
+ | __method=insurance.save-Записывает документ страховки в базу. Значение типа транзакции для запроса – save.__ | ||
- | ==== Данные транзакции для запроса: ==== | + | **Данные транзакции для запроса:** |
<country> - идентификационный номер страны, взятый из списка, полученного в методе load.countries; | <country> - идентификационный номер страны, взятый из списка, полученного в методе load.countries; | ||
- | <amount> - идентификационный номер суммы страхования, взятый из списка, полученного в методе load.insurance_amounts; | + | <amount> - идентификационный номер суммы страхования, взятый из списка, полученного в методе load.insurance_amounts; |
<start-date> - дата выезда из Украины в формате yyyy-MM-dd'T'HH:mm:ss.SSSZ; | <start-date> - дата выезда из Украины в формате yyyy-MM-dd'T'HH:mm:ss.SSSZ; | ||
<end-date> - дата прибытия в Украину в формате yyyy-MM-dd'T'HH:mm:ss.SSSZ; | <end-date> - дата прибытия в Украину в формате yyyy-MM-dd'T'HH:mm:ss.SSSZ; | ||
- | <purposes> - список занятий, которыми будут заниматься застрахованные лица. Формируется как побитовая маска (уточняем для конкретного документа). | + | <purposes> - список занятий, которыми будут заниматься застрахованные лица. Формируется как побитовая маска (уточняем для конкретного документа). |
<program> – идентификационный номер программы страхования, взятый из списка, полученного в методе insurance.calculate; | <program> – идентификационный номер программы страхования, взятый из списка, полученного в методе insurance.calculate; | ||
- | <price> – общая стоимость страховки, полученная путем сложения стоимостей для всех участников страхования. Стоимость страховки для одного участника вычисляется по формуле: price = tariff * ratio * day_count; | + | <price> – общая стоимость страховки, полученная путем сложения стоимостей для всех участников страхования. Стоимость страховки для одного участника вычисляется по формуле: price = tariff * ratio * day_count; |
<insurer> – описание страхователя; | <insurer> – описание страхователя; | ||
<last-name> – фамилия; | <last-name> – фамилия; | ||
Строка 165: | Строка 168: | ||
<human> – описание застрахованного человека (содержание тэга подобно тэгу <insurer>). | <human> – описание застрахованного человека (содержание тэга подобно тэгу <insurer>). | ||
- | XML формат запроса: | + | **XML формат запроса:** |
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<request version="1.0"> | <request version="1.0"> | ||
Строка 211: | Строка 214: | ||
</insured> | </insured> | ||
</transaction> | </transaction> | ||
- | </request> | + | </request> |
- | Данные транзакции для ответа: | + | **Данные транзакции для ответа:** |
- | <insurance> – идентификационный номер документа; | + | |<insurance>|идентификационный номер документа| |
- | <price> – общая стоимость страховки; | + | |<price>|общая стоимость страховки| |
- | <program> – идентификационный номер программы страхования, взятый из списка, полученного в методе insurance.calculate. | + | |<program>|идентификационный номер программы страхования, взятый из списка, полученного в методе insurance.calculate.| |
- | XML формат ответа: | + | **XML формат ответа:** |
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<response> | <response> | ||
Строка 228: | Строка 231: | ||
<price>604.8</price> | <price>604.8</price> | ||
</transaction> | </transaction> | ||
- | </response> | + | </response> |
- | Подпись страховки | + | ==== Подпись страховки ==== |
- | method=insurance.sign – Подписывает документ страховки в базе. Значение типа транзакции для запроса – sign. | + | |
- | Данные транзакции для запроса: | ||
- | <insurance> – идентификационный номер документа; | ||
- | <price> – общая стоимость страховки; | ||
- | <program> – идентификационный номер программы страхования, взятый из списка, полученного в методе insurance.calculate. | ||
- | XML формат запроса: | + | |
+ | __method=insurance.sign-Подписывает документ страховки в базе. Значение типа транзакции для запроса – sign.__ | ||
+ | |||
+ | **Данные транзакции для запроса:** | ||
+ | |||
+ | |<insurance> – идентификационный номер документа| | ||
+ | |<price>|общая стоимость страховки| | ||
+ | |<program>|идентификационный номер программы страхования, взятый из списка, полученного в методе insurance.calculate.| | ||
+ | |||
+ | **XML формат запроса:** | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<request version="1.0"> | <request version="1.0"> | ||
Строка 247: | Строка 254: | ||
<price>604.8</price> | <price>604.8</price> | ||
</transaction> | </transaction> | ||
- | </request> | + | </request> |
- | Данные транзакции для ответа: | + | **Данные транзакции для ответа:** |
- | <insurer> – описание подписанта; | + | |
- | <timestamp> – дата и время подписания в формате yyyy-MM-dd'T'HH:mm:ss.SSSZ; | + | |<insurer>|описание подписанта| |
- | внутри тэга лежит цифровая подпись документа в системе. | + | |<timestamp>|дата и время подписания в формате yyyy-MM-dd'T'HH:mm:ss.SSSZ внутри тэга лежит цифровая подпись документа в системе| |
- | XML формат ответа: | + | **XML формат ответа:** |
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<response> | <response> | ||
Строка 264: | Строка 271: | ||
MCwCFG+HiLJGx1cFU9Q0GWgHcdd5xQgwAhQ9EstdGpS8sNa5spj85ZdQXVVy9w== | MCwCFG+HiLJGx1cFU9Q0GWgHcdd5xQgwAhQ9EstdGpS8sNa5spj85ZdQXVVy9w== | ||
</transaction> | </transaction> | ||
- | </response> | + | </response> |
==== Печать PDF-файлов ==== | ==== Печать PDF-файлов ==== | ||
- | method=document.preview_form – Печатает и возвращает pdf-поток для определенной формы. | + | __**method=document.preview_form** – Печатает и возвращает pdf-поток для определенной формы.__ |
Дополнительные параметры запроса: | Дополнительные параметры запроса: | ||
<form> - идентификационный номер формы. | <form> - идентификационный номер формы. | ||
Данные транзакции для запроса: транзакция отсутствует. | Данные транзакции для запроса: транзакция отсутствует. | ||
Данные транзакции для ответа: транзакция отсутствует. | Данные транзакции для ответа: транзакция отсутствует. | ||
- | method= document.preview – Печатает и возвращает pdf-поток для определенного документа. | + | |
+ | __**method= document.preview** – Печатает и возвращает pdf-поток для определенного документа.__ | ||
+ | |||
+ | Дополнительные параметры запроса: | ||
- | Дополнительные параметры запроса: | ||
<document> - идентификационный номер документа. | <document> - идентификационный номер документа. | ||
Данные транзакции для запроса: транзакция отсутствует. | Данные транзакции для запроса: транзакция отсутствует. | ||
Данные транзакции для ответа: транзакция отсутствует. | Данные транзакции для ответа: транзакция отсутствует. | ||
- | method= document.print – Печатает и возвращает pdf-файл для определенного документа. | + | |
+ | __**method= document.print** – Печатает и возвращает pdf-файл для определенного документа.__ | ||
+ | |||
+ | Дополнительные параметры запроса: | ||
- | Дополнительные параметры запроса: | ||
<document> - идентификационный номер документа. | <document> - идентификационный номер документа. | ||
Данные транзакции для запроса: транзакция отсутствует. | Данные транзакции для запроса: транзакция отсутствует. | ||
Данные транзакции для ответа: транзакция отсутствует. | Данные транзакции для ответа: транзакция отсутствует. |