Secure Connect API
A interface de programação da aplicação Secure Connect (API) dá aos sistemas externos acesso aos dados do Secure Connect. As seguintes informações estão acessíveis através das APIs:
- Dados dos alarmes
- Dados em direto
- Dados da estação
- Dados do dispositivo
- Dados do cliente
- Dados do utilizador
As APIs do Secure Connect são utilizadas apenas para receber os dados. O utilizador não pode controlar os dispositivos ou editar dados através das API do Secure Connect adicionando um cliente externo.
A adicionar um cliente externo
- Inicie sessão no Secure Connect.
- Aceda a Admin > Clientes.
- Selecione um cliente.
- Aceda ao separador Clientes externos.
- Clique no botão Adicionar.
- Introduza um Nome.
- Introduza uma descrição.
É opcional escrever uma descrição. - Clique em Guardar.
É criado um cliente externo e o utilizador recebe uma ID de cliente Auth0 única e um segredo de cliente Auth0 único. É importante guardar o segredo do cliente, pois só é apresentado uma vez. O segredo do cliente é necessário para aceder às API do Secure Connect REST. Se o utilizador esquecer o segredo do cliente, deve ser criado um novo cliente externo.
Documentação API
A documentação do Secure Connect API está disponível na aplicação Secure Connect. Para aceder à documentação API do Secure Connect:
- Inicie sessão na aplicação Secure Connect.
- Clique no ícone do perfil no canto superior direito.
- Clique em Recursos do cliente externo .
- Clique na ligação API para transferir o ficheiro Secure Connect API YAML.
O ficheiro transferido contém as seguintes informações.
- Caminhos API REST
- Formato do pedido
- Formato de resposta
- Informação sobre esquemas
Para obter mais informações sobre o mecanismo de autenticação do Secure Connect e sobre como chamar as API do Secure Connect, clique na ligação do Guia de Instalação nos recursos do cliente Externo. O ficheiro transferido contém as seguintes informações:
- Configurar um cliente externo
- A recuperar o token JWT para autenticação
Perguntas frequentes relacionadas
Muitos utilizadores tiveram questões semelhantes sobre Analytics, Live Data, API e OPC UA Connector.