Criar uma chave de API pessoal (PAT)
Saiba como gerar sua primeira chave de API pessoal no Omnifox para conectar integracoes, scripts ou ferramentas externas ao seu workspace.
Veja este passo no vídeo · Criar uma chave de API
Uma chave de API pessoal (PAT, Personal Access Token) e uma credencial que permite que aplicativos externos (n8n, Zapier, seus proprios scripts) acessem o Omnifox em seu nome, sem compartilhar seu usuario e senha. Cada chave e emitida para um workspace especifico e pode ser limitada a determinadas permissoes.
Antes de comecar
- Seu plano deve incluir Acesso via API (disponivel nos planos superiores). Se nao estiver ativo, voce vera um aviso para fazer upgrade.
- Voce precisa da permissao Gerenciar chaves de API (administradores ja a possuem).
- Voce deve pertencer ao workspace para o qual vai emitir a chave.
Passos
- No menu lateral, abra API Keys (Chaves de API).
- Clique em Nova chave.
- Digite um Nome descritivo (por exemplo, Integracao n8n - Vendas). Ele ajuda a identificar a chave depois.
- Escolha o Workspace em que a chave vai operar. Este campo e obrigatorio: a chave so podera ler e gravar dados desse workspace.
- (Opcional) Selecione os Scopes (permissoes). Se nao marcar nenhum, a chave tera acesso total. O recomendado e conceder apenas o necessario.
- (Opcional) Defina uma data em Expira em para que a chave caduque sozinha.
- Clique em Salvar.
Como verificar
Ao salvar, aparece a janela "Copie e salve agora" com a chave completa. O formato e 123_aBc... com um prefixo visivel como omf_1a2b.
Esta e a unica vez que a chave completa e exibida. Copie-a com o botao Copiar e guarde-a em um gerenciador de senhas. Depois de fechar a janela, so resta o prefixo.
Feche a janela e a nova chave aparece na lista de API Keys com nome, workspace e prefixo.
Se nao funcionar
- Aparece um aviso de plano (erro 402): seu plano nao inclui Acesso via API. Faca upgrade em Faturamento.
- Nao encontro API Keys no menu: falta a permissao
api-keys.view. Peca a um administrador para concede-la. - Nao consigo escolher um workspace: so aparecem os workspaces aos quais voce pertence. Peca para ser adicionado ao correto.
- Perdi a chave: ela nao pode ser recuperada. Exclua a antiga e crie uma nova (ou use Regenerar).
Dicas
- Use uma chave por integracao: se uma vazar, voce a exclui sem afetar as demais.
- Para integracoes automaticas (nao para voce como agente humano), marque Token de servico (bot) ao cria-la.
Artigos relacionados
Artigos relacionados
-
Como conectar integrações e apps externos
Conecte o Omnifox às suas ferramentas favoritas a partir do catálogo de integrações em poucos passos.
-
Integrar o Omnifox com Azur, Siigo, Alegra, QuickBooks ou outro sistema contábil ou ERP
O Omnifox não tem hoje um conector nativo com sistemas contábeis ou ERP. Veja como fazer essa conexão mesmo assim com fluxos de trabalho, o nó HTTP, n8n, Make, Zapier ou a API, com exemplos.
-
Guia completo de integrações e API
Integrações e API a fundo, em 30 capítulos: chaves de API, chamadas reais, webhooks assinados, n8n, MCP e SDKs, tudo funcionando de verdade.
-
Gerar e usar API keys e webhooks
Crie chaves de API para acessar o Omnifox por código e configure webhooks para receber eventos em tempo real.
-
Introdução às integrações (webhook / OAuth / chave de API)
Conecte o Omnifox às suas outras ferramentas: o que está disponível hoje, o que chega em breve e quando usar um webhook, uma conexão OAuth ou uma chave de API.