DOCUMENTAÇÃO TÉCNICA

API do Reencontro.

Endpoints de leitura para consultar casos públicos e, com credencial do painel, casos autorizados para compartilhamento institucional.

API v1 · JSON · Somente leitura

Antes de entregar credenciais a um órgão público

Confirme a autorização institucional e use uma instalação pública com TLS/HTTPS, controle de acesso e política para tratamento dos dados. O cadastro de uma chave no painel não cria convênio nem envia dados automaticamente.

ROTAS DISPONÍVEIS

Endpoints de leitura

Base da API

GET/api/healthDiagnóstico

Verifica a conexão MySQL e confirma se as tabelas do schema estão prontas. Não retorna credenciais nem dados de cadastro.

GET/api/public/casesPúblico

Lista somente casos ativos aprovados para divulgação pública. Não requer chave e retorna apenas campos que podem aparecer no site.

Retornaid, nome, idade, cidade, UF, data da última vez vista, resumo público e prioridade.

GET/api/v1/agency/healthChave institucional

Confirma se a credencial está válida e informa a organização associada.

GET/api/v1/agency/casesChave institucional

Lista casos ativos com autorização documentada para compartilhamento com órgãos e BO registrado. A autorização pública do site é independente.

Parâmetros opcionaislimit (1–100, padrão 50), offset (paginação), updated_since (data/hora ISO).

GET/api/v1/agency/cases/{protocolo}Chave institucional

Consulta um caso autorizado pelo protocolo interno. Casos sem autorização, BO ou ativos retornam 404.

Retorna dados operacionais autorizadosProtocolo, nome, idade, cidade/UF, data e local, descrição, roupas, informação crítica, BO, unidade policial e última atualização. Contatos familiares não são incluídos.

AUTENTICAÇÃO

Chave no cabeçalho

O admin gera uma chave por órgão em Painel → Integrações API. A chave é exibida uma vez, expira em 90 dias e pode ser revogada a qualquer momento.

Authorization: Bearer SUA_CHAVE

Guarde-a em um cofre de segredos no servidor do consumidor. Não a inclua em páginas web, aplicativos móveis, repositórios ou links compartilhados.

EXEMPLO DE RESPOSTA

Casos institucionais

{
  "organization": "Órgão autorizado",
  "total": 1,
  "limit": 50,
  "offset": 0,
  "next_offset": null,
  "cases": [{
    "protocol": "RN-AAAAMMDD-XXXXXX",
    "full_name": "Nome conforme autorização",
    "state": "UF",
    "bo_number": "informado no cadastro"
  }]
}

O exemplo acima é ilustrativo; o payload real contém os campos descritos no endpoint.

INTEGRAÇÃO BACKEND

Exemplo com cURL

Faça chamadas do servidor da instituição. A API usa paginação para limitar cada resposta.

USO RESPONSÁVEL

A API apoia o fluxo.
Não substitui procedimentos oficiais.

O sistema não registra BO nem realiza busca policial.
Credencial técnica não substitui convênio, autorização institucional ou avaliação jurídica.
Os acessos ficam registrados no histórico administrativo.
Não envie dados sensíveis por canais sem proteção adequada.