API приложения Secure Connect
Программный интерфейс приложения (API) предоставляет внешним системам доступ к данным Secure Connect. С помощью API можно получить следующую информацию:
- Данные о сигналах тревоги
- Данные в режиме реального времени
- Данные станции
- Данные устройства
- Данные клиента
- Данные пользователя
API приложения Secure Connect используются только для получения данных. Пользователь не может управлять устройствами или редактировать данные с помощью API Secure Connect путем добавления внешнего клиента.
Добавление внешнего клиента
- Войдите в Secure Connect.
- Перейдите в раздел Администратор > Клиенты.
- Выберите клиента.
- Перейдите на вкладку Внешние клиенты.
- Нажмите кнопкуДобавить.
- Введите имя
- Введите описание.
Написать описание необязательно. - Нажмите Сохранить.
Создается внешний клиент, и пользователь получает уникальный идентификатор клиента Auth0 и одноразовый секрет клиента Auth0. Важно сохранить секрет клиента, поскольку он отображается только один раз. Для доступа к API Secure Connect REST требуется секрет клиента. Если пользователь забыл секрет клиента, необходимо создать новый внешний клиент.
Документация API
Документация Secure Connect API доступна в приложении Secure Connect. Чтобы получить доступ к документации Secure Connect API:
- Войдите в приложение Secure Connect.
- Нажмите на значок профиля в правом верхнем углу.
- Щелкните ресурсы внешнего клиента .
- Нажмите на ссылку API, чтобы загрузить файл Secure Connect API YAML.
Загруженный файл содержит следующую информацию.
- Пути REST API
- Формат запроса
- Формат ответа
- Информация о схеме
Для получения дополнительной информации о механизме аутентификации Secure Connect и о том, как вызвать API Secure Connect, нажмите на ссылку «Руководство по установке» на внешних ресурсах клиента. Загруженный файл содержит следующую информацию:
- Настройка внешнего клиента
- Получение токена JWT для аутентификации
Связанные часто задаваемые вопросы
У многих пользователей были аналогичные вопросы об Analytics, Live Data, API и OPC UA Connector.