Архитектура пользовательских интеграцийBETANEW

Взаимодействие с API позволяет системам обмениваться данными и выполнять различные действия. Для корректной работы интеграции необходимо правильно настроить запросы и аутентификацию, чтобы обеспечить безопасный и эффективный доступ к внешним сервисам.

Интеграция строится из отдельных логических блоков, каждый из которых выполняет конкретную задачу:

• Подключение — содержит данные для доступа к внешнему API
• Блок действий — выполняет определенный тип запроса
• Контекст и переменные — позволяют передавать данные между блоками

Типы запросов

Поддерживаемые типы запросов — GET, POST, PUT, PATCH и DELETE. Каждый тип запроса имеет свои особенности и ограничения, которые необходимо учитывать при разработке интеграций.

• GET — для получения данных из системы, например, для получения списка объектов или статусов. Эти запросы не изменяют данные и не создают новые записи
• POST — для создания новых записей или отправки данных в систему, например, для создания файлов или пользователей
• PUT — для полного обновления существующих записей
• PATCH — для частичного обновления записей
• DELETE — для удаления данных

Принципы аутентификации

Для взаимодействия с внешними системами используются различные механизмы аутентификации. На основе предоставленных параметров подключений создаются безопасные каналы для обмена данными между вашей системой и целевыми сервисами.

oAuth2

OAuth2 — это протокол аутентификации, который позволяет приложениям получать доступ к ресурсам без передачи логина и пароля. Протокол обеспечивает безопасную аутентификацию и упрощает процесс доступа к интегрируемым сервисам.

Сервисы, поддерживающие OAuth2, позволяют получить клиентский идентификатор и секретный ключ. Для этого необходимо перейти на официальный сайт выбранного сервиса в раздел с документацией по API и следовать инструкциям для регистрации приложения и получения необходимых данных.

Для аутентификации этим способом пользователю необходимо указать в настройках подключения параметры, полученные от сервиса.

Этот способ аутентификации используется в интеграциях с такими сервисами, как Google Drive, Google Таблицы, Microsoft SharePoint, amoCRM и другими.

Basic Auth

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

Для аутентификации эти способом необходимо указать свои учетные данные в настройках подключения интеграции. Рекомендуется использовать защищенные соединения для передачи данных.

Например, этот способ аутентификации используют интеграции с инструментом управления проектами Jira.

API Key

Ключ API — это уникальный идентификатор, используемый для аутентификации запросов к API, который позволяет системам взаимодействовать между собой и обеспечивает доступ к нужным ресурсам без прохождения пользовательской аутентификации. Ключ API обычно передается в заголовках HTTP-запросов или в параметрах URL. Он служит для идентификации приложения и разрешает доступ к API сервиса.

Для получения ключа API необходимо зайти в свою учетную запись на выбранном сервисе, сгенерировать ключ и настроить для него права доступа.

Например, этот способ аутентификации используют интеграции с Proceset.

Блоки действий

Блок действия представляет собой основной исполняемый элемент интеграции. Он отвечает за выполнение конкретного запроса к внешнему API.

Блок может выполнять следующие задачи:

• Отправлять данные во внешнюю систему
• Получать и обрабатывать ответы от API
• Формировать выходные данные для следующих блоков
• Использовать переменные из контекста (например, значения, полученные ранее)

Такой блок является ключевым элементом логики интеграции, так как именно он взаимодействует с внешним сервисом.