Documentação API

1. Endpoints disponíveis

• Dados em tempo real: GET /api/v1/realtime para obter valores atuais de sensores e equipamentos.
• Histórico de produção: GET /api/v1/production/history para consultar dados de produção com filtros por data.
• Gestão de alarmes: GET /api/v1/alarms e POST /api/v1/alarms/acknowledge para listar e reconhecer alarmes.

2. Autenticação OAuth2

• Obtenção de token: POST /api/v1/auth/token com credenciais client_id e client_secret no corpo da requisição.
• Renovação de token: POST /api/v1/auth/refresh com refresh_token válido para obter novo access_token.
• Autorização: Inclua o token no cabeçalho Authorization: Bearer {token} em todas as requisições.

3. Exemplos de requisições

• Consulta de dados: GET /api/v1/devices/status com parâmetros opcionais ?type=plc&status=active.
• Envio de comandos: POST /api/v1/devices/{id}/command com payload JSON contendo parâmetros do comando.
• Tratamento de erros: Códigos de erro padronizados (400, 401, 403, 404, 500) com mensagens descritivas no corpo da resposta.

1. Configuração de servidores

• Instalação: Configure o servidor OPC UA com suporte a TCP/IP binário (opc.tcp://) na porta 4840.
• Descoberta: Habilite o serviço Local Discovery Server (LDS) para permitir descoberta automática de endpoints.
• Interoperabilidade: Configure perfis de conformidade mínimos (UA 1.04) para garantir compatibilidade com clientes.

2. Estrutura de endereçamento

• Namespace: Organize os nós em namespaces lógicos (ex: Empresa.Planta.Área.Equipamento.Variável).
• Modelagem de objetos: Utilize tipos de objetos padronizados (FolderType, DeviceType) para organizar a hierarquia.
• Browsing: Implemente referências hierárquicas (HasComponent, HasProperty) para facilitar a navegação na árvore de objetos.

3. Segurança e certificados

• Políticas de segurança: Configure Basic256Sha256 com SignAndEncrypt para comunicações seguras.
• Gestão de certificados: Implemente renovação automática de certificados e revogação via CRL.
• Autenticação: Configure autenticação por certificado X.509 ou username/password dependendo do nível de segurança necessário.

1. Configuração de brokers

• Instalação: Configure o broker MQTT (recomendado: Mosquitto ou HiveMQ) com suporte a TLS na porta 8883.
• Clustering: Implemente cluster de brokers para alta disponibilidade com balanceamento de carga.
• Persistência: Configure armazenamento persistente para mensagens retidas e filas de clientes desconectados.

2. Estrutura de tópicos

• Hierarquia recomendada: empresa/planta/área/equipamento/variável para organização lógica dos dados.
• Convenções de nomenclatura: Use apenas caracteres alfanuméricos, hífen e underscore, evitando espaços e caracteres especiais.
• Tópicos especiais: Utilize $SYS/ para monitoramento do broker e status/ para estado de conexão dos dispositivos.

3. Qualidade de serviço (QoS)

• QoS 0 (at most once): Use para dados não críticos como leituras frequentes de sensores (temperatura, umidade).
• QoS 1 (at least once): Recomendado para a maioria dos dados operacionais como status de equipamentos.
• QoS 2 (exactly once): Reserve para mensagens críticas como comandos de controle e alarmes de segurança.