Gerenciamento de Chaves API
Como gerar, gerenciar e usar chaves API para acesso programático aos cálculos do ExCoil a partir do seu ERP ou sistemas customizados.
1. Visão Geral
Chaves API permitem que usuários do plano Enterprise acessem o motor de cálculo do ExCoil programaticamente via API REST. Isso permite integração com sistemas ERP, software de seleção customizado, ferramentas de cotação automatizada e fluxos de cálculo em lote. Cada chave API é uma credencial única que autentica requisições aos endpoints /api/v1/.
Apenas Enterprise: A geração de chaves API requer uma assinatura Enterprise ativa. Planos Professional e Free não possuem acesso à API.
2. Gerando uma Chave
- Navegue até a página de Chaves API na barra lateral do dashboard
- Clique em 'Gerar Nova Chave'
- Insira um nome descritivo (ex: 'Integração ERP', 'Ferramenta de Cotação')
- Selecione permissões (calc:read para cálculos, projects:read para acesso a projetos)
- Copie a chave gerada imediatamente — ela não será mostrada novamente
Chaves API seguem o formato: exk_[64 caracteres hexadecimais]. O prefixo 'exk_' identifica como uma chave API do ExCoil. Apenas os primeiros 12 caracteres (prefixo) são armazenados para exibição; a chave completa é hasheada por segurança.
3. Permissões
| Permissão | Escopo | Descrição |
|---|---|---|
| calc:read | Cálculos | Executar todos os endpoints de cálculo |
| projects:read | Projetos | Ler dados de projetos e versões |
| * | Todos | Acesso total a todos os endpoints da API |
4. Limites de Taxa
Cada chave API tem um limite de taxa de 100 requisições por minuto por padrão. Informações de limite de taxa são incluídas nos cabeçalhos de resposta:
X-RateLimit-Limit: Máximo de requisições por minutoX-RateLimit-Remaining: Requisições restantes na janela atualX-RateLimit-Reset: Timestamp Unix quando a janela reseta
5. Melhores Práticas de Segurança
- Nunca exponha chaves API em código do lado do cliente ou repositórios públicos
- Use variáveis de ambiente para armazenar chaves na sua aplicação
- Crie chaves separadas para diferentes aplicações ou ambientes
- Revogue chaves imediatamente se comprometidas
- Use as permissões mínimas necessárias para cada chave
- Máximo de 10 chaves ativas por conta
6. Gerenciando Chaves
Na página de Chaves API, você pode:
- Visualizar: Ver prefixo da chave, nome, data de criação, última utilização e contagem de requisições
- Revogar: Desativar uma chave (para de aceitar requisições mas mantém o registro)
- Excluir: Remover permanentemente uma chave e seu histórico de uso