Перейти к основному содержимому

Узел admin-api

Этот узел позволяет взаимодействовать с различными API, что полезно для интеграции с внешними сервисами.

Настройки узла admin-api​

IMG2

1. Name​

Поле для указания имени узла.
Имя отображается в рабочей области и помогает легко идентифицировать узел.
Если оставить пустым, узел будет называться admin-api.

Пример:

  • Имя узла: Create Payment Session

2. Type​

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

  • "Update page object" (Обновление объекта страницы):

  • "Search all objects on product pages with pagination for the selected category" (Поиск всех объектов страниц товаров с пагинацией для выбранной категории):

  • "Changing the status of the product page" (Изменение статуса у страницы товара):

  • "Product page update" (Обновление страницы товара):

  • "User object update - admin" (Обновление объекта пользователя - админа):

  • "Update one user object" (Обновление одного объекта пользователя):

  • "Updating the value of one entity attribute" (Обновление значения одного атрибута сущности):

  • "Receiving all orders belonging to the order storage object" (Получение всех заказов, принадлежащих объекту хранилища заказов):

  • "Updating the status of an order belonging to the order storage object" (Обновление статуса у заказа, принадлежащему объекту хранилища заказов):

  • "Payment session update" (Обновление сеанса оплаты):

  • "Receiving one payment session object by its identifier" (Получение одного объекта сеанса оплаты по его идентификатору):

  • "Creating a payment session" (Создание сессии оплаты):

  • "Receiving all records belonging to the collection" (Получение всех записей, принадлежащих коллекции):

  • "Creating a record in the collection" (Создание записи в коллекции):

  • "Changing a record in the collection" (Изменение записи в коллекции):

  • "Deleting an object from the collection record" (Удаление объекта записи коллекции):

3. Query parameters​

Это поле использует шаблон Mustache для формирования данных запроса в формате JSON.
Вы можете использовать данные из сообщения msg для подстановки значений в шаблон.

Пример шаблона (для метода "Receiving all records belonging to the collection"):

 {
   "entityType": "orders",
   "entityId": "{{orderId}}",
   "langCode": "en_US",
   "offset": 0,
   "limit": 1,
   "marker": "delivery"
 }

В этом примере значение orderId будут подставлены из сообщения msg. При использовании шаблонов Mustache вы можете передавать сложные данные и параметры, необходимые для взаимодействия с API.

4. Request body​

Это поле использует шаблон Mustache для формирования данных запроса в формате JSON.
Вы можете использовать данные из сообщения msg для подстановки значений в шаблон.

Пример шаблона (для метода "Creating a payment session"):

 {
   "orderId": {{orderId}},
   "type": "session"
 }

В этом примере значение orderId будут подставлены из сообщения msg. При использовании шаблонов Mustache вы можете передавать сложные данные и параметры, необходимые для взаимодействия с API.

Примеры запросов​

Пример 1: Создание платежной сессии​

Настройки узла:

  • Type: Creating a payment session
  • Request body: 
    {
      "orderId": {{orderEvent.order.id}},
      "type": "session"
    }

Результат:
Узел отправит запрос для создания сессии оплаты с данными из сообщения. В результате будет получена информация о новой сессии оплаты.

Пример 2: Обновление платежной сессии​

Настройки узла:

  • Type: Payment session update
  • Query parameters: 
    {
      "id": {{paymentSessionId}}
    }
  • Request body: 
    {
      "status": "{{status}}"
    }

Результат:
Узел отправит запрос для обновления статуса сессии оплаты, используя предоставленные значения paymentSessionId и status.