В этой статье объясняется, как использовать API в DevZone с EloView 4
Ниже описано, как использовать API в Elo DevZone. Эта статья охватывает следующее:
1. Генерация учетных данных OAuth
2. Получение токена аутентификации
3. Авторизация API
4. Получение OrgId:
5. Запуск API
1. Генерация учетных данных OAuth
OAuth (Open Authorization) - это стандартный протокол авторизации, который предоставляет приложениям возможность "безопасного конкретного доступа". Это будет использоваться для получения токена авторизации.
a. Войдите на веб-сайт EloView: https://secure.eloview.com/
b. Нажмите на иконку профиля
c. Нажмите на Генерация учетных данных OAuth
d. Скопируйте и вставьте учетные данные oAuth (clientID и clientSecret) в блокнот, затем нажмите ОК
2. Получение токена аутентификации
Это процесс аутентификации пользователей или процессов для облачных приложений. Приложение пользователя отправляет запрос на службу аутентификации, которая подтверждает личность пользователя и выдает токен. Пользователь затем может получить доступ к приложению.
a. Нажмите на вкладку API
b. Разверните сетку аутентификации и нажмите на кнопку “Попробовать” (показано на изображении ниже), она позволит вам ввести значения для требуемых параметров и покажет кнопку выполнения внизу бокса API.
c. Добавьте Client Id (параметр пути) и clientsecret как параметр тела (полученный из учетных данных OAuth / Шаг 1), затем нажмите на выполнить.
d. Это даст токен аутентификации, который можно использовать в дальнейших операциях.
e. Проверьте тело ответа и скопируйте access_token из ответа. Это будет использоваться как Bearer токен для доступа к другим API. Ответ будет выглядеть как изображение ниже.
3. Авторизация API
Токены доступа - это то, что приложения используют для выполнения API-запросов от имени пользователя. Токен доступа представляет собой авторизацию конкретного приложения для доступа к определенным частям данных пользователя.
a Нажмите на кнопку Авторизовать, расположенную в верхнем правом углу экрана.
b Это откроет диалоговое окно, откуда мы можем добавить значение токена доступа для авторизации API.
c. Введите bearer & вставьте токен доступа в поле ввода.
d. Нажмите на кнопку Авторизовать & закройте всплывающее окно
e. Теперь пользователь авторизован для доступа к любому доступному API.
4. Получение OrgId:
OrgId (идентификатор организации) будет использоваться для выполнения различных действий API из Dev-zone.
a. Нажмите на иконку шестеренки
b. OrgId находится в правом нижнем углу
5. Запуск API
После авторизации мы можем запускать API из dev-zone.
a. Разверните модуль, например, Контент / Получить список контента
b. Нажмите Попробовать
c. Введите ORG ID
d. Выберите Выполнить
Результаты должны выглядеть следующим образом:
Please report any broken links by emailing support@elotouch.com and include a link to the knowledge article