Histórico de versões da API
Esta página registra as mudanças da API pública do NearOne Trust que afetam integrações. A versão em vigor aparece também no topo da Referência da API.
Como versionamos
- Todas as rotas da organização ficam sob o prefixo
/api/v1/. Qualquer mudança que exija ajuste nas integrações será registrada nesta página. - São consideradas compatíveis (podem chegar a qualquer momento): novos endpoints, novos campos em respostas, novos valores em campos de texto de domínio (por exemplo, uma nova etapa de fluxo), novos códigos de erro e novos tipos de evento de webhook.
- Por isso, a sua integração deve ignorar campos desconhecidos nas respostas e tratar valores desconhecidos de forma segura (por exemplo, exibir o rótulo em vez de quebrar).
- Atenção à direção oposta: nos corpos dos comandos de casos, campos desconhecidos são recusados. Envie apenas os campos documentados.
0.1.0+48 — linha de base atual
Primeira versão pública documentada. Ela estabelece a superfície descrita abaixo, que serve de referência para as próximas entradas deste histórico.
Endereço: https://api.trust.nearone.com.br · Referência: 290 caminhos e 361 operações publicadas.
Áreas da API
| Área | O que cobre | Referência |
|---|---|---|
| Manifestações e fluxos | Casos (listagem, detalhe, contadores, quadros, calendário), mensagens e notas internas, atribuição, triagem, mudança de etapa, atividades, lembretes, relações entre casos, anexos e histórico; configuração de categorias, fluxos e tipos de solicitação | Manifestações e fluxos |
| Denúncias e canais | Canais e links, categorias de denúncia, empresas atendidas, equipe protegida, proteção de casos, conflitos de interesse, análise, prazos (SLA) e feriados, triagem assistida, automações, avisos por e-mail, integrações com Slack e Teams, indicadores, ações preventivas, cartaz, retenção e pacotes de evidências | Denúncias e canais |
| Canal público | Envio de relato, anexos do relato, acompanhamento com protocolo e chave, mensagens de quem relatou, recuperação de acesso e avisos | Canal público |
| Autenticação | Login, renovação de sessão, encerramento, senha, convites e segundo fator | Autenticação |
| Minha conta | Perfil, sessões, senha, e-mail de recuperação, chaves pessoais e conexões MCP | Minha conta |
| Organização, membros, papéis e grupos | Perfil e políticas de segurança da organização, convites e vínculos, papéis e permissões, grupos de membros | Organização · Membros · Papéis · Grupos |
| Empresas | Empresas atendidas, grupos de empresas e contatos | Empresas · Grupos de empresas · Contatos de empresas |
| Chaves de API | Emissão, consulta, ajuste e revogação de chaves sgk_ | Chaves de API |
| Webhooks | Assinaturas, catálogo de eventos, pausa e retomada, rotação de segredo, teste, entregas e reenvio | Webhooks |
| Notificações, arquivos, etiquetas e auditoria | Caixa de notificações, arquivos da organização, etiquetas e trilha de auditoria | Notificações · Arquivos · Etiquetas · Auditoria |
| Base de conhecimento | Documentos e conversas por empresa | Base de conhecimento |
| MCP e OAuth | Servidor MCP em /mcp e o fluxo OAuth que autoriza clientes de IA | MCP · OAuth (MCP) |
| Inteligência artificial | Provedores, chaves e limites da IA da organização (configuração feita por pessoas) | Inteligência artificial |
| Saúde | Verificações de disponibilidade | Saúde |
Convenções em vigor
- Credenciais: token de acesso de pessoa (JWT) e chaves de API
sgk_live_— veja Autenticação. - Listagens com
limit,cursor,sort,qefiltere resposta{items, page}. - Erros com
{code, message, request_id}, mensagens em português. - Comandos de casos com
request_nonce(recibo de 7 dias) eexpected_version. Idempotency-Key(24 horas) nas demais rotas de escrita.- Códigos públicos de 4 caracteres no caminho; UUIDs em filtros e corpos.
Detalhes em Convenções da API.