API de Secure Connect
La interfaz de programación de aplicaciones (API) de Secure Connect proporciona a los sistemas externos acceso a los datos de Secure Connect. La API permite acceder a la siguiente información:
- Datos de alarmas
- Datos en vivo
- Datos de estación
- Datos del dispositivo
- Datos de los clientes
- Datos de los usuarios
Las API de Secure Connect solo se utilizan para recibir los datos. El usuario no puede controlar los dispositivos ni editar datos mediante las API de Secure Connect añadiendo un cliente externo.
Añadir un cliente externo
- Inicie sesión en Secure Connect.
- Vaya a Admin > Clientes.
- Seleccione un cliente.
- Vaya a la pestaña Clientes externos.
- Haga clic en el botón Añadir.
- Introduzca un Nombre.
- Introduzca una Descripción.
Es opcional escribir una descripción. - Haga clic en Guardar.
Se crea un cliente externo y el usuario obtiene un ID de cliente Auth0 único y un secreto de cliente Auth0 único. Es importante guardar el secreto del cliente, ya que solo se muestra una vez. El secreto del cliente es necesario para acceder a las Secure Connect API REST. Si el usuario olvida el secreto del cliente, debe crearse un nuevo cliente externo.
Dcoumentación de la API
La documentación API de Secure Connect está disponible en la aplicación Secure Connect. Para acceder a la documentación API de Secure Connect:
- Inicie sesión en la aplicación Secure Connect.
- Haga clic en el icono de perfil en la esquina superior derecha.
- Haga clic en los Recursos del cliente externo.
- Haga clic en el enlace API para descargar el archivo API YAML de Secure Connect.
El archivo descargado contiene la siguiente información.
- Rutas API REST
- Formato de solicitud
- Formato de respuesta
- Información del esquema
Para obtener más información sobre el mecanismo de autenticación de Secure Connect y cómo llamar a las API de Secure Connect, haga clic en el enlace Guía de instalaciónen los recursos del cliente externo. El archivo descargado contiene la siguiente información:
- Configuración de un cliente externo
- Recuperación del token JWT para la autenticación
Preguntas frecuentes relacionadas
Muchos usuarios han tenido preguntas similares sobre Analytics, Live Data, API y OPC UA Connector.