Documentação da API

Guia completo para usar os endpoints de consulta da API

Endpoint Base

URL base para realizar consultas na API

GET https://novaera.cloud/apis/consulta.php

Parâmetros Obrigatórios

Todos os parâmetros abaixo são obrigatórios para realizar uma consulta

token
Seu token de acesso (bearer token) fornecido pelo administrador.
type
Tipo de consulta (endpoint do comando). Exemplos: cpf, cpf2, cpf3, fotoes, telefone, parentes, fotoma, logs e comandos.
query
Dados para consultar (CPF, telefone, URL, etc. dependendo do tipo).

Formato da URL

https://novaera.cloud/apis/consulta.php?token=SEU_TOKEN&type=TIPO_CONSULTA&query=DADOS

Exemplos de Uso

Exemplos práticos de como usar a API para diferentes tipos de consulta

Consulta de CPF (cpf3)
https://novaera.cloud/apis/consulta.php?token=seu_token_aqui&type=cpf3&query=12345678901
Consulta de Telefone
https://novaera.cloud/apis/consulta.php?token=seu_token_aqui&type=telefone&query=11987654321
Consulta de Foto (fotoes)
https://novaera.cloud/apis/consulta.php?token=seu_token_aqui&type=fotoes&query=12345678901
Consulta de CPF (cpf2)
https://novaera.cloud/apis/consulta.php?token=seu_token_aqui&type=cpf2&query=12345678901
Consulta de Parentes
https://novaera.cloud/apis/consulta.php?token=seu_token_aqui&type=parentes&query=12345678901
Consulta de Logs
https://novaera.cloud/apis/consulta.php?token=seu_token_aqui&type=logs&query=https://google.com
Consultar comandos autorizados
https://novaera.cloud/apis/consulta.php?token=SEU_TOKEN&type=comandos&query=0
{"success":true,"data":{"COMANDOS":{"comandos_autorizados":["cpf","placa","fotoes","fotoma"]}}}

Códigos de Resposta HTTP

Entenda os códigos de status HTTP retornados pela API

200
Sucesso
A consulta foi realizada com sucesso. O corpo da resposta contém os dados solicitados.
400
Parâmetros Inválidos
Faltam parâmetros obrigatórios (token, type ou query).
401
Token Inválido
O token fornecido não existe ou é inválido.
403
Acesso Negado
Token inativo, expirado ou sem permissão para este comando.
404
Comando Não Encontrado
O tipo de consulta especificado não existe ou está inativo.
500
Erro no Servidor
Erro ao processar a consulta. Verifique os logs do servidor.

Formato de Resposta

Estrutura dos dados retornados pela API

A resposta pode ser em formato JSON ou texto, dependendo do tipo de consulta: 
{
  "nome": "João Silva",
  "cpf": "12345678901",
  "data_nascimento": "01/01/1990",
  "endereco": "Rua Exemplo, 123",
  ...
}

Permissões

Como funcionam as permissões de acesso aos comandos

Cada token pode ter permissões específicas para determinados comandos. Se o token tiver permissões definidas, ele só poderá acessar os comandos listados.

Se não houver permissões específicas, o token terá acesso total a todos os comandos disponíveis.

Validade do Token

Informações sobre a expiração dos tokens

Os tokens têm uma data de expiração. Após a expiração, o token não poderá mais ser usado. Entre em contato com o administrador para renovar ou gerar um novo token.

Segurança

Boas práticas de segurança para proteger seu token

Importante:
  • Nunca compartilhe seu token com terceiros
  • Use HTTPS em produção para proteger o token durante a transmissão
  • Se suspeitar que seu token foi comprometido, solicite a geração de um novo token
  • Mantenha o token seguro e não o exponha em código-fonte público
  • Não faça commit do token em repositórios Git

Como Obter um Token

Passos para adquirir um token de acesso

Para obter um token de acesso, entre em contato com o administrador do sistema.

O administrador irá gerar um token personalizado com as permissões necessárias para suas consultas.