API Keys e Integrações

O que é

A página de API Keys permite gerar e gerenciar chaves de acesso à API do ConvertaFlow. Com uma chave de API, você pode integrar sistemas externos — ERPs, CRMs, plataformas de e-commerce, ferramentas próprias — para enviar e receber dados da plataforma de forma programática.

Onde acessar: Configurações > API Keys

Criar uma chave de API

Acesse Configurações > API Keys
Clique em Nova Chave
Dê um nome descritivo para identificar a integração (ex: "ERP Interno", "Site de Vendas")
Clique em Gerar
Copie a chave imediatamente — ela é exibida apenas uma vez por segurança

Após fechar o modal, a chave não pode ser visualizada novamente. Se perder, será necessário revogar e criar uma nova.

Usar a chave nas chamadas à API

Inclua a chave no header de todas as requisições:

Authorization: Bearer SUA_CHAVE_AQUI

A documentação completa da API — endpoints disponíveis, parâmetros e exemplos — está disponível em app.convertaflow.com/api/docs após o login.

Gerenciar chaves existentes

Na lista de chaves você vê:

Nome da integração
Data de criação
Último uso — quando a chave foi usada pela última vez
Status — ativa ou revogada

Revogar uma chave

Se uma chave foi comprometida ou não é mais necessária, revogue-a:

Na lista, clique no ícone de lixeira ao lado da chave
Confirme a revogação

Chaves revogadas param de funcionar imediatamente. Todas as integrações que usavam aquela chave deixarão de funcionar — certifique-se de atualizar antes de revogar.

Permissões e isolamento

Cada chave de API opera dentro do escopo da sua organização. Não é possível acessar dados de outras organizações com uma chave da sua conta.

As ações realizadas via API são registradas nos logs de auditoria da plataforma, identificadas como "via API" com o nome da chave utilizada.

Boas práticas de segurança

Nunca compartilhe sua chave em código-fonte público, repositórios Git ou mensagens
Use uma chave por integração — facilita revogar individualmente sem afetar outras integrações
Revogue chaves não utilizadas — se uma integração foi desativada, revogue a chave correspondente
Monitore o campo "Último uso" — chaves com data de uso muito antiga podem ser candidatas à revogação

Perguntas frequentes

Quantas chaves posso criar?

Não há limite definido de chaves por organização.

Uma chave de API expira automaticamente?

Não. As chaves não têm data de expiração — elas ficam ativas até serem revogadas manualmente.

Posso limitar o que cada chave pode fazer?

No momento, todas as chaves têm acesso completo à API da organização. Escopos granulares por chave serão disponibilizados em versão futura.

Tem como ver as requisições feitas por uma chave?

Os logs de auditoria em Configurações > Logs de Auditoria registram ações realizadas via API, incluindo o nome da chave utilizada.