Documentação técnica
Referência da API, do sistema de eventos, dos webhooks e dos protocolos para agentes da XEN, para a equipe técnica que integra a plataforma aos seus próprios sistemas.
A referência é publicada seção por seção, na ordem deste índice.
Cada seção sai com os seus exemplos de requisição e resposta conferidos contra o servidor em produção. Uma equipe que precise integrar hoje recebe a referência dos endpoints que usa e uma pessoa da Xeneural durante a integração.
Solicitar a referência para uma integraçãoOito seções
Autenticação
Cada requisição leva o token de sessão do usuário no cabeçalho de autorização; o servidor valida esse token, resolve quem é o usuário e recusa qualquer requisição sem token antes de tocar em um único dado.
Escopo de organização
A organização ativa é resolvida pelo servidor a partir da sessão; o cliente nunca a declara na requisição, então um identificador enviado de fora não consegue abrir os dados de outra empresa.
Endpoints de vendas
Emissão de documentos, rascunhos e agendamento; consulta da situação; notas de crédito e de débito vinculadas ao original; séries por ponto de emissão.
Endpoints de estoque
Movimentações de entrada e de saída, transferências entre armazéns, ajustes com motivo e consulta do saldo físico e do disponível por item e por armazém.
Sistema de eventos
Todo resultado do servidor leva um código de evento pequeno e sequencial vindo de um registro único; os códigos são lidos do mesmo catálogo no aplicativo, nas integrações e nos agentes.
Webhooks
Cadastro de um destino por organização, formato do envio, assinatura para verificar a origem e política de novas tentativas quando o destino não responde.
Protocolos para agentes
Como um agente externo se autoriza com MCP, AP2 e UCP, opera com as permissões do usuário que o autorizou e deixa cada ação no mesmo histórico que uma pessoa.
Erros e códigos
Formato da resposta de erro, catálogo de códigos por família (validação, permissões, fiscal, integração) e o que corrigir em cada caso antes de tentar de novo.