Glossário · Socialfy Docs

Conta: o espaço de um cliente no Nexus. Chaves, linhas e webhooks pertencem a uma conta e nunca a atravessam.
Subconta: o espaço do CRM associado a uma operação dentro da conta. Algumas credenciais e eventos são limitados a uma subconta.
Linha, chip ou instância: o número de WhatsApp conectado ao Nexus. Na API o nome é instanceId; no painel aparece como chip.
instanceId: o nome dado à linha na criação (minúsculas, números e hífen). É chave natural: único por conta.
Conexão: o tipo de ligação da linha com o canal. A conexão pública operável hoje é WhatsApp por QR; outras aparecem só como estado observado nos recursos.
Recursos (capabilities): o que uma conexão ou uma linha consegue fazer, lido em GET /api/nexus/capabilities e no endpoint de recursos efetivos da instância.
Chave de API da conta: credencial de integração com prefixo nx_acct_, escopos e validade opcional. Opera toda a conta dentro dos escopos.
Chave da linha: credencial de um único chip, prefixo nx_live_. Só consulta e envia pelo próprio chip.
Sessão do painel: o JWT de uma pessoa logada. Carrega o papel dela e expira.
Papel: o que uma pessoa pode na conta: dono, administrador ou membro. Gerenciar chaves exige dono ou administrador.
Escopo: permissão nomeada, como instances:read. A credencial carrega um conjunto e a operação exige um.
Idempotência: propriedade de uma operação que, repetida, produz o mesmo efeito uma vez só. No Nexus vem da chave natural ou da Idempotency-Key.
Idempotency-Key: cabeçalho de 16 a 128 caracteres que identifica a intenção de um envio. O mesmo valor reaproveita a intenção em vez de duplicar.
Identificador de correlação: valor devolvido em erros e logs para o suporte localizar a requisição.
Webhook: chamada HTTPS que o Nexus faz à sua URL quando um evento acontece numa linha.
Assinatura de webhook: HMAC SHA-256 do corpo bruto com o segredo configurado, no cabeçalho X-Nexus-Signature no formato sha256=<hex>.
Espelhamento no CRM: opção do webhook que mantém o evento também refletido no CRM vinculado.
MCP (Model Context Protocol): protocolo pelo qual agentes de IA chamam ferramentas de um servidor. O Nexus expõe um servidor MCP de diagnóstico e reconexão.
Contrato público: o conjunto de operações, campos, erros e credenciais publicados na referência e no OpenAPI. O que está fora dele pode mudar sem aviso.
Prévia: recurso disponível para algumas contas antes de entrar no contrato público, sem garantia de compatibilidade.
Descontinuação: retirada anunciada de uma operação ou campo, com período de transição.
E.164: formato internacional de telefone com + e código do país, como +5511999990000.