Интеграция с API 5S AUTO

Статья в разработке

Актуально для релиза 2.8.1.

Содержание

Введение

API 5S AUTO* представляет собой общий канал для взаимодействия с web-сервисами 5S AUTO.

*API (application programming interface) представляет собой набор функций, посредством которых программа отправляет запросы и обменивается данными с внешними сервисами.

API 5S AUTO позволяет извлекать данные из программы через http-запрос для использования их при взаимодействии с web-сервисами. Программа может обратиться к web-сервису с запросом информации – например, об автомобиле в базе ГИБДД. Web-сервис может обратиться к программе для получения данных из базы – например, о клиенте.

API 5S AUTO используется для настройки следующего функционала программы:

   ●     загрузка накладных поставщиков – для загрузки обработчиков из общего хранилища;
   ●     расшифровка автомобилей по гос. номеру в базе ГИБДД;
   ●     прием онлайн-оплаты через СБП;
   ●     интеграция с Telegram (версия 3);
   ●     интеграция с web-приложением 5S LINK;
   ●     распознавание товаров при сканировании штрихкодов;
   ●     разрешительный режим касс для проверки кодов маркировки;
   ●     подтверждение списания бонусов по QR-коду клиента;
          и др.

Чтобы начать работу с API 5S AUTO, необходимо быть клиентом 5SYSTEMS – подписка либо облако.

Для настройки интеграции с API требуются логин и пароль – их необходимо запросить в техподдержке 5SYSTEMS.

Настройка

Создание интеграции

Для настройки интеграции сначала необходимо создать новый элемент справочника “Интеграции”:

На форме создания новой интеграции требуется:

1. Выбрать вид интеграции “API 5S AUTO”; 
2. Выбрать обработчик подключения “5S AUTO”;
3. На вкладке “Параметры сервиса” ввести регистрационные данные – логин и пароль, запрошенные ранее в техподдержке 5SYSTEMS;
4. Установить галочку “Включено”; 
5. Записать.

Настройка внешнего подключения

Для пользователей облачной версии программы настройки выполняются специалистами 5SYSTEMS, для пользователей коробочной версии – собственным системным администратором.

Перейти к настройкам внешнего подключения следует через кнопку "Методы интеграции" на вкладке "Тест подключения":

В данном окне должны быть заполнены параметры:

   ●    API URL – адрес web-публикации, по которому доступно подключение к текущей базе 1С для облачных сервисов компании 5SYSTEMS.
         Должны быть даны разрешения на подключение к этому URL-адресу для данных http-сервисов.
         Подключение выполняется с серверов компании 5SYSTEMS с IP-адресов: 178.69.191.141 и 77.93.122.98;
   ●    Логин и Пароль – авторизационные данные пользователя базы 1С, под которым будет выполняться внешнее подключение.

Адрес для подключения следует получить:

   ●   для пользователей облачной версии – у специалистов техподдержки 5SYSTEMS;
   ●   для пользователей коробочной версии – у своего системного администратора.

Для проверки корректности URL-адреса следует скопировать его и открыть через адресную строку браузера – браузер запросит логин и пароль. Необходимо их ввести для проверки отсутствия ошибки входа.

Тест подключения

После настройки необходимо сделать тест подключения – на вкладке “Тест подключения” нажать кнопку “Методы интеграции → Получить параметры пользователя”. При успешном подключении будет выведена информация с данными пользователя:

Обновление внешнего кэша данных

Обновление внешнего кэша данных требуется для синхронизации данных между базой 1С и внешними web-приложениями, для того чтобы внесенные в базе настройки отобразились в приложении. 

Автоматическое обновление данных происходит 1 раз в 5 минут при срабатывании регламентного задания “Обмен с микросервисом”. Для проверки активности регламентного задания следует на вкладке "Тест подключения" перейти в “Методы интеграции → Обновить внешний кэш данных”:

Есть возможность запустить регламентное задание вручную – для того, чтобы обновился кэш, и внесенные настройки сразу отобразились в приложении. Для этого нужно нажать кнопку запуска: