Документация по СПИК

Введение

Данный документ предназначен для интеграторов и разработчиков расширений для СКАУТ-Платформы. В нём представлены основные возможности СПИК – Сервиса Программной Интеграции и Коммуникации версии 1.0.

Документ состоит из нескольких частей.

1. Описание основных понятий и определений.
2. Описание базовых действий.
3. Описание сценариев взаимодействия с системой.
4. Описание контрактов данных и операций СПИК.

Методические рекомендации:
Рекомендуем сначала ознакомиться со СКАУТ-Платформой и овладеть используемой терминологией.
Далее следует перейти к изучению описания основных сценариев использования. Каждый из них состоит из определенной последовательности действий. Отдельное действие также может быть сценарием. Алгоритм выполнения действия представлен в секции Базовые действия данного руководства. Если в определённом сценарии необходимо выполнение другого сценария, в первом будет поставлена соответствующая ссылка.

Оглавление

1. Глоссарий предметной области  
2. Глоссарий технических терминов  
3. Общее описание системы СПИК  
4. Базовые действия  
1. Получение базового адреса сервера приложений  
2. Преобразование пользовательских типов в формат JSON  
3. Отправка POST запроса при взаимодействии через REST  
4. Работа с запросами в СПИК по REST  
5. Создание заглушки сервиса в среде Visual Studio. СПИК  
6. Реализация авторизации в заглушке SOAP сервиса на C#  
7. Авторизованный запрос к SOAP сервису в 1С  
5. 5. Сценарии СПИК 
1. Авторизация в СПИК 
2. Запрос объектов мониторинга 
3. Запрос онлайн данных 
4. Запрос построения отчета и его отправки на почтовые адреса 
5. Запрос статистик 
6. Адреса сервисов в REST и SOAP 
7. Контракты данных авторизации 
8. Контракты данных отдачи объектов мониторинга 
9. Контракты данных отдачи групп объектов мониторинга  
10. Контракт онлайн-данных
11. Контракт онлайн-данных с датчиками      
12. Контракты отчетов
13. Контракты статистик данных 
14. Общие (инфраструктурные) контракты 
15. Контракты методов:
1. Сервис авторизации 
2. Сервис описания СПИК 
3. Сервис построения отчетов 
4. Сервис получения онлайн-данных 
5. Сервис контроллера построения статистик 
6. Сервис статистик по дискретным датчикам 
7. Сервис статистик по расходу топлива 
8. Сервис статистик по заправкам и сливам топлива 
9. Сервис статистик по режимам работы двигателя 
10. Сервис статистик по валидации навигационных данных 
11. Сервис статистик по фильтрации навигационных данных 
12. Сервис статистик по треку 
13. Сервис статистик по треку по каждому периоду 
14. Сервис запроса транспортных средств  
15. Сервис запроса групп транспортных средств