Portal Técnico KNShield

KNShield API - Sistema de Monitoramento e Controle

API corporativa para autenticação, multiempresa, gestão de ativos, monitoramento operacional e integração em tempo real.

Abrir Swagger UI Guia Técnico de Integração OpenAPI JSON

Política de Exposição da Documentação

OwnerOnly and master-specific business rules are hidden in this public documentation view.

Ambientes Conhecidos

  • Dev http://localhost:3000
  • Production https://api.knsh.com.br

Artefatos de Documentação

  • Swagger UI Interface interativa para descoberta de endpoints, autenticação e testes manuais.
  • OpenAPI JSON Contrato técnico para automação, geração de SDKs e validação de schema.
  • Guia Técnico HTML Visão orientada a empresas integradoras, arquitetura e operação da API.
  • Guia Técnico Markdown Versão textual para distribuição, versionamento e revisão documental.

Fluxo Recomendado de Onboarding

  1. 01 Comece pelo portal público para entender o mapa geral da plataforma.
  2. 02 Use o Swagger UI para autenticar e validar os endpoints reais publicados.
  3. 03 Consuma o OpenAPI JSON em automações, SDKs e testes de contrato.
  4. 04 Use o guia técnico para alinhar tenancy, segurança e operação com o cliente.
/

Portal de Documentação

Ponto de entrada para clientes, integradores e times técnicos navegarem entre visão executiva, guia técnico e contrato OpenAPI.

/swagger

Swagger UI

Interface interativa para autenticação, exploração de endpoints e validação manual de requests.

/swagger/json

OpenAPI JSON

Contrato estruturado para geração de SDKs, automação de testes e validação de schema.

/docs/guide

Guia Técnico HTML

Leitura orientada a arquitetura, segurança, tenancy e operação para integrações corporativas.

Autenticação e Segurança

A integração principal usa Bearer Token JWT. A autorização é controlada por papel e permissões por módulo, com segregação clara entre perfis globais e escopo por empresa.

Modelo Multiempresa

A API deve ser tratada como plataforma multi-tenant. O backend é a fonte de verdade para escopo, posse e autorização, e clientes não devem inferir acesso global a partir de IDs conhecidos.

Contratos Estáveis

Os módulos auth, user, address, status-type, map, device, installation e company concentram a parte mais estável da superfície técnica atual para integrações corporativas.

Canais de Integração

A plataforma oferece REST/JSON para integrações primárias, OpenAPI para descoberta de schema e WebSocket para cenários de atualização operacional em tempo real. Fluxos assíncronos internos continuam encapsulados pela própria API.

Este portal está amarrado à configuração pública da API e funciona como ponto de entrada entre a documentação comercial/técnica e o contrato OpenAPI oficial.