Моделирование API запроса
Чтобы создать простой GET запрос через внешний API, нужно выбрать раздел Business Logic и во вкладке External API Requests нажать на кнопку Create API request. В новом модальном окне введите имя бизнес процесса и описание (опционально).
Далее, нужно выбрать тип запроса, адрес endpoint и заполнить необходимые параметры запроса (query params в примере ниже). В некоторых примерах необходимо заполнять header, body и url params, все зависит от стоящей перед пользователем задачи.
В редакторе БП можно так же протестировать процесс, нажав на Test request. В появившемся окне необходимо ввести параметры запроса и нажать на Execute request. В случае успеха, тело ответа будет получено во вкладке body. Autofill Response производит парсинг ответа и помогает создавать необходимые модели. Нажав на Autofill Response, шаблон ответа для данного endpoint будет автоматически создан для будущего использования.
Зная поля ответа, возможно создать модель данных. Для этого нужно перейти в Data Design и создать новую модель, заполнив ее согласно данным, которые должны быть записаны в базу.
Использование API запроса в бэкенде
После автозаполнения шаблона ответа, его возможно использовать в бизнес процессах. Откройте раздел Business Logic и нажмите Create business process, чтобы создать БП получения данных по внешнему API и записи их в соответствующую модель данных (Data Model). В соответствующих блоках нужно найти блок созданного API процесса.
Для того, чтобы запрос работал, нужно передать соответствующие параметры, настроенные ранее в редакторе внешнего API запроса. В нашем случае - это Query Params. Обработка и создание данных в БП происходят с помощью комбинаций блоков Make - Expand. Пример создания и передачи параметров на вход запроса, аналогично тестовому API запросу в редакторе внешних API запросов, представлен ниже на скриншоте.
Далее, на выходе, в случае успешного запроса, нужно развернуть тело ответа запроса и сохранить нужные данные в модель данных. В нашем примере мы получали цену биткоина в долларах. Поэтому в ответе получаем цену в usd:
Записать данные в базу данных возможно с помощью комбинации блоков Make и DB: Create.
Далее, для только что созданного БП нужно создать endpoint, к которому можно обращаться из фронтенда приложения.
Использование API запроса во фронтенде приложения
В БП фронтенда приложения необходимо использовать блок Server request для обращения к только что созданному endpoint, как на примере ниже: