Pular para o conteúdo principal

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​

ÁreaO que cobreReferência
Manifestações e fluxosCasos (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çãoManifestações e fluxos
Denúncias e canaisCanais 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ênciasDenúncias e canais
Canal públicoEnvio de relato, anexos do relato, acompanhamento com protocolo e chave, mensagens de quem relatou, recuperação de acesso e avisosCanal público
AutenticaçãoLogin, renovação de sessão, encerramento, senha, convites e segundo fatorAutenticação
Minha contaPerfil, sessões, senha, e-mail de recuperação, chaves pessoais e conexões MCPMinha conta
Organização, membros, papéis e gruposPerfil e políticas de segurança da organização, convites e vínculos, papéis e permissões, grupos de membrosOrganização · Membros · Papéis · Grupos
EmpresasEmpresas atendidas, grupos de empresas e contatosEmpresas · Grupos de empresas · Contatos de empresas
Chaves de APIEmissão, consulta, ajuste e revogação de chaves sgk_Chaves de API
WebhooksAssinaturas, catálogo de eventos, pausa e retomada, rotação de segredo, teste, entregas e reenvioWebhooks
Notificações, arquivos, etiquetas e auditoriaCaixa de notificações, arquivos da organização, etiquetas e trilha de auditoriaNotificações · Arquivos · Etiquetas · Auditoria
Base de conhecimentoDocumentos e conversas por empresaBase de conhecimento
MCP e OAuthServidor MCP em /mcp e o fluxo OAuth que autoriza clientes de IAMCP · OAuth (MCP)
Inteligência artificialProvedores, chaves e limites da IA da organização (configuração feita por pessoas)Inteligência artificial
SaúdeVerificações de disponibilidadeSaú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, q e filter e resposta {items, page}.
  • Erros com {code, message, request_id}, mensagens em português.
  • Comandos de casos com request_nonce (recibo de 7 dias) e expected_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.