Convenções Comuns

Formato de Resposta

Endpoints de Leitura

Endpoints de leitura (GET) normalmente retornam diretamente o objeto de dados de negócio, sem um campo code. Por exemplo:

{
  "sSerialNumber": "RC1126B-20240101-001",
  "sFirmwareVersion": "V1.0.10"
}

Endpoints de Operação

Endpoints de operação (POST, PUT, DELETE) retornam um objeto contendo code e message:

{
  "code": 0,
  "message": "success"
}

code=0 significa sucesso. Um code diferente de zero indica um erro, e message fornece uma descrição.

Resposta de Erro

Quando uma solicitação falha, o dispositivo retorna:

{
  "code": 401,
  "message": "Unauthorized: Invalid token or NO token provided"
}

Nomenclatura de Campos

Os nomes de campos JSON usam camelCase. A primeira letra indica o tipo de dado:

Prefixo	Tipo	Exemplo
i	Inteiro	iCpuUsage
f	Ponto flutuante	fTemperature
s	String	sSerialNumber
b	Booleano	bRunning
l	Lista	lDetection
d	Objeto	dIpv4

Construção de URL

Endpoints CGI

A maioria dos endpoints requer o caminho base CGI:

http://<DEVICE_IP>/cgi-bin/entry.cgi/<API_PATH>

Endpoints de Caminho Direto

Alguns endpoints ignoram a camada CGI e são acessados diretamente:

http://<DEVICE_IP>/api/v1/device/serial-port
http://<DEVICE_IP>/api/v1/file?path=/mnt/sdcard/test.mp4

Autenticação

Com poucas exceções (/system/key, /system/login, /system/check), todos os endpoints exigem o Token no cabeçalho da requisição:

Cookie: token=<JWT_TOKEN>

Consulte Authentication para saber como obter um Token.

Códigos de Erro

Os códigos de erro são segmentados por módulo funcional:

Prefixo	Módulo
100xx	Dispositivo e Sistema
200xx	Visualização ao Vivo
300xx	Gravação
400xx	Inferência de IA
500xx	Terminal e Logs

Códigos de erro comuns:

Código	Descrição
10001	Senha muito fraca
10002	Token expirado
10003	Um download de firmware já está em andamento
10004	Número de porta fora do intervalo
10005	Número de porta já em uso

Consulte Error Codes para a lista completa.

Suporte Técnico e Discussão de Produtos

Obrigado por escolher nossos produtos! Estamos aqui para oferecer a você diversos tipos de suporte para garantir que sua experiência com nossos produtos seja a mais tranquila possível. Oferecemos múltiplos canais de comunicação para atender a diferentes preferências e necessidades.