Вступление

Конструктор интеграций позволяет самостоятельно добавить приложение (сервис) в Albato, при условии, что у приложения есть открытое API.

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

Механика добавления, состоит из принципа “копировать-вставить”, вам нужно лишь открыть вашу API документацию, скопировать с неё URL запроса, переменные и вставить в конструктор

Workflow

Создаётся приложение, дается ему наименование, затем при необходимости, создаётся авторизация, в которой настраивается метод получения авторизационных данных и обновления, если требуется (Access token) и “шаблон” заполнения API запроса с авторизационными данными. Далее можно использовать созданную авторизацию в остальных сущностях, таким образом не нужно будет каждый раз в запросах добавлять переменные, в которые кладутся авторизационные данные.

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

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

Публикация

После того, как будут добавлены триггеры или действия, они станут доступны в личном кабинете пользователя Albato, который создал данное приложения. Любые изменения, которые будут происходить с настройками приложения, происходят “на лету” и сразу же применяются. Но если вам нужно, что бы ваше приложение стало доступно для всех пользователей Albato, вам нужно будет отправить приложение на модерацию. В момент модерации, как и после публикации, приложение запрещено для редактирования.




Далее, модератор проверит работоспособность вашей интеграции и если все тесты пройдены успешно, ваше приложение станет публичным и доступным для всех пользователей Albato.

Таким образом, вы можете добавить своему приложению огромный список интеграций без разработчиков. С вашей системой будут открыты интеграции со множеством CRM, CMS, Маркетинговых систем. Всё что требуется - добавить ваше приложение.

Версионирование

Если после того как приложение опубликовано, нужно что то в нём изменить, то создаётся новая версия, которая является полной копией публичной версии.




В данной версии, можно добавлять/изменять/удалять все сущности. После всех изменений, приложение отправляется на модерацию. После создания версии, в личном кабинете - владельца приложения, становится доступна новая версия со всеми изменениями. Данная версия доступна только владельцу, в остальных аккаунтах Albato будет работать опубликованная версия. После модерации, происходит “слияние” версий и ваша новая версия становится доступной уже всем пользователям. Рассмотрим поведение при “слиянии” на примере сущности “Действие”:

В версии добавилась сущность - У пользователей появляются новые сущности, при создании связки можно выбрать новое действие

В версии изменилось существующее действие - У пользователей, во всех текущих связках происходит замена самого шага. То есть, если добавилось/удалилось поле или изменилась структура запроса, то пользователям не нужно создавать по новой связки, все изменения произойдут в существующих связках. Данный сценарий подходит, когда изменения незначительные и не сильно влияют на работу действия, например: изменить наименование поля, добавить поле, изменить структуру запроса с теми же полями.

В версии удалилось действие - У пользователей, у которых уже есть связка с данным действием, связка продолжит работу, весь шаг будет неизменен и запросы уходить будут по старым настройкам. Но при попытке создать новую связку, пользователь больше не увидит данного действия, оно сможет работать только в “старых” связках.

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

Обновлено на: 28/11/2022