Пример технического задания на создание веб сервиса для расчета тарифа

Веб сервис для расчета тарифа по согласованному страховому продукту для внешних программ.

1. Назначение сервиса.

Получение значения тарифа из внешних учетных систем (агрегаторов, систем ввода полисов) из существующей бек-офисной информационной системы (далее ИС) посредством прямого доступа к API ИС посредством сети Internet.

1.2. Сервис предназначен для использования в согласованном страховом продукте.

1.3. Сервис должен содержать механизм автоматического создания описания API для внешних

разработчиков.

2. Технология создания сервиса.

2.1. Платформа ASP.NET, версия .NET Framework от 6.1 и выше.

2.2. Технология создания сервиса webapi 2.0.

2.3. Протоколы HTTP или HTTPS.

2.4. Формат JSON для обмена данными.

3. Аутентификация внешних пользователей.

3.1. Система авторизации пользователей ИС с вводом дополнительных признаков.

4. Функциональность сервиса.

4.1. Идентификация пользователя.

4.2. Первоначальная проверка принятых данных, для возможности передачи в процедуру расчета тарифа. Параметры для расчета тарифа согласовывается с Заказчиком.

4.3. Вызов хранимой процедуры расчета тарифа с передачей данных.

4.4. Получение результата работы процедуры.

4.5. Возвращение результата работы вызывающей внешней программе посредством API.

4.6. Ведение протокола действий в log-файле.

4.7. Предусмотреть в сервисе вызов методов и функциональность для получения информации по продукту.

4.8. Предусмотреть в сервисе класс для возможности реализации расширенной логики на сервере с целью разгрузки сервера базы данных.

5. Функциональность хранимой процедуры.

5.1. Проверка данных принятых данных.

5.2. Идентификация клиента по согласованному алгоритму. Использование существующего клиента либо создание нового.

5.3. Расчет тарифа в ИС. Проверка корректности завершения всех операций расчета.

5.4. Передача результата работы процедуры (значение тарифа) в сервис.

6. Документирование.

6.1. Реализация механизма автоматического создания Заказчиком описания API для внешних

разработчиков запуском системы документирования на своей площадке.

6.2. Использование системы документирования Swagger.

6.3. Адрес запуска Заказчиком системы создания документации по API - http://адрес сайта/swagger

7. Тестирование.

7.1. Использование приложения Advanced Rest Client Application для тестирования сервиса.

7.2. Создание инструкции для Заказчика по использованию Advanced Rest Client Application для данного

сервиса.