Autenticação
Segurança
Mantenha suas chaves de API seguras e nunca as compartilhe com partes não autorizadas. Essas chaves fornecem acesso à sua conta e serviços da plataforma.
NUNCA deixe suas chaves de API expostas diretamente no código front-end (JavaScript, HTML, aplicativos móveis, etc.). Chaves expostas podem ser facilmente acessadas por qualquer usuário, comprometendo a segurança da sua conta. Use sempre um backend/servidor para fazer as requisições com as chaves de API.
Acessando sua Chave
Sua primeira chave de API está disponível diretamente na home do painel administrativo:
- Acesse o painel administrativo
- No menu lateral dentro de desenvolvedores clique em Chaves de API
- Clique em criar nova chave
- Adicione um nome
- Copie a chave e guarde A CHAVE DE API SÓ SERÁ MOSTRADA UMA VEZ
Prefixos das Chaves
Nossas chaves de API utilizam prefixos específicos para identificar o ambiente:
| Prefixo | Ambiente | Descrição |
|---|---|---|
cpk_sandbox_ | Teste | Chaves para ambiente de desenvolvimento e testes |
cpk_live_ | Produção | Chaves para processamento de pagamentos reais |
Exemplo de Chaves
# Chave Sandbox
cpk_sandbox_1a2b3c4d5e6f7g8h9i0j
# Chave de Produção
cpk_live_9i8h7g6f5e4d3c2b1a0jSandbox não é dinheiro de mentira
Uma chave cpk_sandbox_ cria cobranças PIX reais, na mesma adquirente configurada
na instância — não existe simulação de pagamento na API. Na prática, sandbox só
muda duas coisas: (1) ignora o limite de vendas mensal de contas pessoa física, e
(2) se a adquirente ativa da instância for a Woovi, roteia pra API sandbox da
própria Woovi. Com qualquer outra adquirente, uma chave sandbox processa a cobrança
exatamente igual a uma chave live.
Chaves de Produção
Importante
Chaves de produção (cpk_live_) só podem ser criadas após a validação
completa dos documentos dentro da plataforma.
Processo para Chaves de Produção
- Validação de Documentos - Complete o processo de validação
- Aprovação da Conta - Aguarde a aprovação da nossa equipe
- Acesso Liberado - Após aprovação, o botão para criar chaves de produção será habilitado
Quando Usar Cada Tipo
| Situação | Chave Recomendada |
|---|---|
| Desenvolvimento e testes | cpk_sandbox_ |
| Homologação | cpk_sandbox_ |
| Produção com transações reais | cpk_live_ |
Informações das Chaves
Na tela de gerenciamento, você visualiza:
- Nome da chave - Identificação personalizada
- Prefixo - Tipo de ambiente (sandbox/prod)
- Status - Ativo/Inativo
- Data de criação - Quando foi gerada
- Último uso - Última atividade registrada
- Rotacione chaves periodicamente para manter a segurança
- Use chaves diferentes para diferentes serviços/ambientes
- Desative chaves não utilizadas para reduzir riscos
- Monitore o uso através dos logs de atividade
- Nunca commite chaves no código fonte
Utilizando as Chaves
Autenticação HTTP
Inclua a chave no header de autorização:
curl -X GET "https://api.sua-instancia.com/charge/:id" \
-H "X-API-KEY: cpk_sandbox_sua_chave_aqui" \
-H "Content-Type: application/json"Exemplo de Integração
const apiKey = 'cpk_sandbox_sua_chave_aqui';
fetch('https://api.sua-instancia.com/charge/:id', {
method: 'GET',
headers: {
'X-API-KEY': `${apiKey}`,
'Content-Type': 'application/json'
}
})
.then(response => response.json())
.then(data => console.log(data));Migração Teste → Produção
Quando sua conta for aprovada:
- Crie chaves de produção na tela de gerenciamento
- Substitua as chaves em sua aplicação
- Atualize a URL base se necessário
- Teste em homologação antes do go-live
Dica
Mantenha sempre chaves de teste ativas mesmo em produção para facilitar novos desenvolvimentos e testes de funcionalidades.