Терминология
Приложение: Сервис, который добавлен в конструктор и имеет в себе все собранные сущности. Является связкой “Подключение” + “триггеры” или “действия”. Выводится в Albato в списке подключений, как доступный пользователю партнёр.
Виджет запроса: Виджет, в котором настраивается сам HTTP запрос в API. Настраивается как сам исходящий запрос, настраивается парсер ответа и обработка ошибок у данного запроса. Появляется во всех сущностях, которые делают API запросы.
Подключение: Предоставление конечным пользователем доступ, к приложению, с его данными. Все введённые данные при создании, сохраняются в рамках одного подключения и используются в дальнейшем, для построения API запросов. Количество подключений не ограничено.
Авторизация: Созданная модель поведения авторизации в приложении. Настраивается: какие параметры запрашивать у пользователя при создании подключения для сохранения в памяти подключения этих данных и последующей передаче их во всех остальных API запросах. Так же настраивается модель получения токенов доступа и их обновления, при необходимости.
Поля подключения: Пользовательские поля, которые запрашиваются у конечного пользователя Albato, при создании подключения с приложением. Это поля, которые не относятся напрямую к авторизации и могут быть использованы везде. Например, это может быть домен или поддомен, который пользователь укажет в подключении и значение сохранится в рамках его подключение. Далее значение можно использовать во всех остальных сущностях, подставляя его в URL запроса.
Триггеры: Сущность, которая реагирует на нужное событие, в зависимости от настроек. Когда происходит нужное событие, связка запускается, получая данные этого события и передаёт их дальше в шаги действий. У триггеров есть две модели поведения, “Webhook” - триггер запускается, когда на определённый URL приходит запрос и проходит через фильтр, “API” - триггер самостоятельно опрашивает сервис через HTTP запросы раз в пять минут, получая список новых/изменённых сущностей, фильтруя дополнительно сущности по ID/Дате изменения (что бы через пять минут не получить дубликаты)
Действия: Сущность, которая производит исходящий HTTP запрос в сервис, по заданному сценарию (на определённый URL с преднастроенным телом запроса). Действие происходит после того, как в связке сработал триггер и передаёт в сервис все заполненные в связке поля.
Списки: Динамические (получение элементов через API) или статичные списки, которые в дальнейшем можно привязывать к определённому полю действия. Например есть поле “Статус”, в которое нужно положить ID определенного статуса, но статусы и эти ID у всех разные, динамический список позволит получить ID статусов у конечного пользователя и в настройках действия поле превратится в список. Список так же может быть статичным, с определённым набором элементов.
Ловец хуков: Сущность, которая привязывается к триггерам с моделью поведения “Webhook”. Ловец позволяет получить в связку тестовый вебхук со всеми нужными параметрами и под каждый параметр, создать отдельное поле триггера, значения этих параметров, будут передаваться в эти поля. Необходим, когда у триггера практически нет набора статичных полей и каждый раз нужно получать разные.
Списки пользовательских полей: Аналогично обычным спискам. Через API получается список конкретных пользовательских полей, список привязывается к триггеру или действию и у конечного пользователя появляются его поля
Строковая секция: Определённый набор полей, который находится в массиве объектов ( [ { } ] ), может приходить в триггерах и отправляться в экшенах. Сама секция, представляет из себя один конкретный массив, а поля секции, это поля которые находятся в каждом объекте этого массива. Добавив в триггер строковую секцию, можно получить по событию вместе с самой сущностью, и весь её вложенный массив (например, товары), в котором нет строго определённого набора объектов.
Виджет запроса: Виджет, в котором настраивается сам HTTP запрос в API. Настраивается как сам исходящий запрос, настраивается парсер ответа и обработка ошибок у данного запроса. Появляется во всех сущностях, которые делают API запросы.
Подключение: Предоставление конечным пользователем доступ, к приложению, с его данными. Все введённые данные при создании, сохраняются в рамках одного подключения и используются в дальнейшем, для построения API запросов. Количество подключений не ограничено.
Авторизация: Созданная модель поведения авторизации в приложении. Настраивается: какие параметры запрашивать у пользователя при создании подключения для сохранения в памяти подключения этих данных и последующей передаче их во всех остальных API запросах. Так же настраивается модель получения токенов доступа и их обновления, при необходимости.
Поля подключения: Пользовательские поля, которые запрашиваются у конечного пользователя Albato, при создании подключения с приложением. Это поля, которые не относятся напрямую к авторизации и могут быть использованы везде. Например, это может быть домен или поддомен, который пользователь укажет в подключении и значение сохранится в рамках его подключение. Далее значение можно использовать во всех остальных сущностях, подставляя его в URL запроса.
Триггеры: Сущность, которая реагирует на нужное событие, в зависимости от настроек. Когда происходит нужное событие, связка запускается, получая данные этого события и передаёт их дальше в шаги действий. У триггеров есть две модели поведения, “Webhook” - триггер запускается, когда на определённый URL приходит запрос и проходит через фильтр, “API” - триггер самостоятельно опрашивает сервис через HTTP запросы раз в пять минут, получая список новых/изменённых сущностей, фильтруя дополнительно сущности по ID/Дате изменения (что бы через пять минут не получить дубликаты)
Действия: Сущность, которая производит исходящий HTTP запрос в сервис, по заданному сценарию (на определённый URL с преднастроенным телом запроса). Действие происходит после того, как в связке сработал триггер и передаёт в сервис все заполненные в связке поля.
Списки: Динамические (получение элементов через API) или статичные списки, которые в дальнейшем можно привязывать к определённому полю действия. Например есть поле “Статус”, в которое нужно положить ID определенного статуса, но статусы и эти ID у всех разные, динамический список позволит получить ID статусов у конечного пользователя и в настройках действия поле превратится в список. Список так же может быть статичным, с определённым набором элементов.
Ловец хуков: Сущность, которая привязывается к триггерам с моделью поведения “Webhook”. Ловец позволяет получить в связку тестовый вебхук со всеми нужными параметрами и под каждый параметр, создать отдельное поле триггера, значения этих параметров, будут передаваться в эти поля. Необходим, когда у триггера практически нет набора статичных полей и каждый раз нужно получать разные.
Списки пользовательских полей: Аналогично обычным спискам. Через API получается список конкретных пользовательских полей, список привязывается к триггеру или действию и у конечного пользователя появляются его поля
Строковая секция: Определённый набор полей, который находится в массиве объектов ( [ { } ] ), может приходить в триггерах и отправляться в экшенах. Сама секция, представляет из себя один конкретный массив, а поля секции, это поля которые находятся в каждом объекте этого массива. Добавив в триггер строковую секцию, можно получить по событию вместе с самой сущностью, и весь её вложенный массив (например, товары), в котором нет строго определённого набора объектов.
Обновлено на: 28/11/2022
Спасибо!