В процессе настройки интеграций между веб-сервисами на платформе Пинкит часто требуется протестировать работу того или иного инструмента и проверить, работает ли обмен данными по API. Ранее в Пинкит не было возможности протестировать интеграцию до завершения процесса ее настройки. Сегодня расскажем о релизе инструмента "Протестировать", как им пользоваться и как он упрощает работу с шагом настройки "Инструменты".
1. Зачем нужно тестировать интеграцию до запуска. Проблема и решение
Интеграции между внешними сервисами по API настраиваются в личном кабинете Пинкит. Всего в настройке есть пять шагов, но на шаге 2 "Инструменты". Но чтобы гибко настроить необходимый вам бизнес-сценарий, вы можете добавить на шаге 2 неограниченное число инструментов. Например, это может быть фильтр, запрос на создание или получение данных, проверка или форматирование данных.
Чем больше инструментов задействовано в интеграции, тем сложнее сама настройка и время на ее реализацию. Если вы добавляете много инструментов на шаге 2, то количество API-запросов в интеграции возрастает и, соответственно, больше вероятность возникновения ошибок (к примеру, из-за некорректно сформулированного запроса).
Раньше отследить ошибки можно было в журнале интеграции только после ее запуска:
Но в процессе настройки логика инструментов может быть ошибочной и отследить эти ошибки используя журнал, оказалось недостаточно. Появилась необходимость проверки каждого инструмента интеграции на шаге 2, а также шагов 1, 3 и 4.
Помимо этого, нам потребовалась функция для получения кода необходимого поля. Если нам нужно провести какие-то вычисления или действия с определённым полем, ранее код поля нужно было искать вручную. Теперь благодаря функции "Скопировать путь к полю" можно получить код поля автоматически:
Добавление инструмента тестирования на каждом этапе настройки помогает снизить количество ошибок, автоматически получить коды нужных полей и подставить свои тестовые данные, чтобы проверить работу интеграции на них.
Далее расскажем подробнее, как работает инструмент.
2. Функция "Протестировать" на шаге 1 настройки интеграции Пинкит
На "Шаг 1: Откуда" мы вводим, к примеру, следующие данные:
Откуда отправляем данные - Битрикс24;
Событие: Сделка - создана;
Подключение к приложению - доступ к нужному порталу Битрикс24.
Соответственно, мы получим данные по последней указанной сущности, то есть, сделке. В тестовых данных будут перечислены все поля сделки, из которых можно получить пути к этим полям, если потребуется.
Установленный фильтр на Шаге1 влияет на отправляемый запрос при нажатии кнопки "Протестировать". Это означает, что если указать filter.ID = 1, то он вернет сущность с идентификатором 1 - сделку, задачу, контакт, компанию или смарт-процесс, и эта сущность появится в тестовых данных.
Как использовать функцию "Получить путь к полю"?
Путь к полю можно использовать на Шаг 2: Инструменты, например, если вы добавите какой-то инструмент, вы можете скопировать путь к полю и вставить его в настройках: "Название поля" или "Условие".
3. Функция "Протестировать" на шаге 2 настройки интеграции Пинкит
Теперь на "Шаг 2: Инструменты" вы можете отдельно протестировать каждый инструмент, который добавите. Сделать это можно двумя путями:
3.1. Кнопка "Показать тестовые данные"
В окне создания инструмента с помощью кнопки "Показать тестовые данные" можно получить перечень доступных полей. Путь к каждому полю можно получить автоматически и подставить в нужный вам инструмент:
3.2. Кнопка "Протестировать"
Проверить С помощью кнопки "Протестировать" в списке инструментов на шаге 2.
С помощью данного функционала вы можете отдельно протестировать каждый инструмент интеграции: проверку, запрос, фильтрацию, обращение к языковой модели и так далее.
4. Функция "Тестовые данные" на каждом шаге настройки интеграции
Получить тестовые данные можно на каждом шаге интеграции, если вы используете эту опцию на шаге 2, вы увидите тестовые данные по всем инструментам, а не по одному конкретному:
5. Функция "Тестовые данные" на шаге 4 настройки интеграции
На шаге 4 мы настраиваем сопоставление данных. Если вы хотите получить развернутую информацию о тестовых данных, нужно нажать на шаг вопроса. тут также можно получить путь к нужному полю и подставить в сопоставление.
Для пользовательского сопоставления есть аналогичная функция:
6. Журнал интеграции
Если полученной вами информации недостаточно, переходим в журнал интеграции и устанавливаем фильтр "Получение данных".
Выбираем интеграцию и нажимаем "Подробнее".
Во всплывающем окне получаем развернутую информацию из журнала, копируем ее:
Далее идем на шаг 1. Нажимаем "Тестовые данные" и затем "Очистить":
Добавляем скопированные данные из журнала, сохраняем:
И далее снова нажимаем "Тестовые данные". Так мы получим все данные, которые отдает API сервиса. Часто это бывает полезно, если документация описана недостаточно.
Итог
С помощью функционала "Протестировать" и "Тестовые данные" вы можете на каждом шаге интеграции проверить, нет ли в настройках ошибок, а также получить недостающие данные, к примеру, коды специальных пользовательских полей.