Skip to main content
As rotas /integrations/external usam uma chave de integração no cabeçalho Authorization, com o esquema Bearer. A chave tem o prefixo wegly_ e não é um JWT nem o token de login de um usuário. Envie a chave completa em cada requisição. A empresa é identificada pela chave; não é necessário enviar company_id para escolher a empresa.
Defina WEGLY_API_KEY no ambiente do seu servidor. Chaves inativas, excluídas, expiradas ou não reconhecidas retornam 401.

​
Restrição de domínio

Quando a chave tem um domínio permitido, a API verifica o hostname do header Origin, ou de Referer se Origin estiver ausente. Nesse caso, omitir ambos também retorna 401. O hostname é comparado em letras minúsculas, sem o prefixo www.; outros subdomínios precisam corresponder ao domínio configurado.

​
Permissões e acesso aos registros

A chave precisa ter a permissão indicada em cada rota, com o módulo e a permissão ativos para a empresa. Permissão insuficiente retorna 403. Serviços que usam um usuário como ator utilizam o criador da chave e aplicam também suas regras de acesso aos registros. Se esse usuário estiver inativo, as rotas que dependem dele retornam 403. Exemplos de permissões: crm/lead.read, crm/deal.create, crm/proposal.update, crm/task.read, crm/file.create, crm/document.read e crm/custom-field.read. Algumas operações exigem mais de uma permissão, como as de chat e as de anexos de proposta: nesses casos, a chave precisa de todas. Algumas delas também conferem as permissões do próprio usuário criador da chave no CRM; consulte a referência da rota. A chave guarda as permissões concedidas no momento em que foi criada ou editada. Permissões que passaram a existir depois não são acrescentadas automaticamente, mesmo em chaves criadas com todas as permissões: edite a chave para concedê-las. A chave é criada e gerenciada nas configurações da Wegly.

​
Como criar uma Chave de Acesso (API) na Wegly

​
1. Acessar as Configurações

  1. No canto superior direito da tela, clique no ícone de engrenagem ⚙️ para acessar as configurações.
  2. Role a página até encontrar a seção Integrações.
  3. Clique na opção Gerenciar chaves.

​
2. Criar uma Nova Chave

  1. Na tela de gerenciamento, clique no botão Nova chave.
  2. Preencha os campos necessários:
    • Nome: Dê um nome para a chave (Ex: “Chave demonstrativa”).
    • Domínio (Opcional): Você pode restringir o acesso a um domínio específico para aumentar a segurança.
    • Data de Validade (Opcional): Defina até quando essa chave funcionará.

​
3. Configurar Permissões

É recomendado seguir o princípio do privilégio mínimo:
  1. Desative a seleção de todas as permissões.
  2. Clique em Gerenciar permissões.
  3. Selecione apenas o que será utilizado.
    • Exemplo: Se for para um formulário de contato, marque apenas Criar Leads.

​
4. Salvar e Copiar

  1. Clique em Salvar.
  2. Clique em Criar chave.
  3. ⚠️ IMPORTANTE: Clique imediatamente no botão Copiar.
    • A chave completa é exibida apenas uma vez. Se você fechar a janela sem copiar, não conseguirá vê-la novamente.
    • Salve-a em um local seguro (como seu gerenciador de senhas ou variáveis de ambiente).