Skip to main content
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.

​
Chave Automática na Criação da Conta

Ao criar sua conta, uma chave de API de teste é gerada automaticamente e fica disponível para uso imediato. Esta chave permite que você comece a testar a integração sem configurações adicionais.

​
Acessando sua Chave na Home

Sua primeira chave de API está disponível diretamente na home do painel administrativo:
  1. Acesse o painel administrativo
  2. Na tela inicial (home), você encontrará sua chave de API
  3. Clique no ícone de copiar para copiar a chave

​
Prefixos das Chaves

Nossas chaves de API utilizam prefixos específicos para identificar o ambiente:
PrefixoAmbienteDescrição
cpk_sandbox_TesteChaves para ambiente de desenvolvimento e testes
cpk_prod_ProduçãoChaves para processamento de pagamentos reais

​
Exemplo de Chaves

# Chave de Teste
cpk_sandbox_1a2b3c4d5e6f7g8h9i0j

# Chave de Produção
cpk_prod_9i8h7g6f5e4d3c2b1a0j

​
Gerenciamento de Chaves

​
Acessando o Gerenciamento

Além da chave disponível na home, você pode gerenciar todas as suas chaves através da tela específica:
  1. Acesse as Configurações - Navegue até “Configurações” na barra lateral
  2. Chaves API - Selecione a aba “Chaves API”
  3. Visualize e gerencie todas as suas chaves
Configurações - Chaves API

​
Criando Novas Chaves de Teste

Para criar chaves de teste adicionais:
  1. Clique em “Criar chave API”
  2. Escolha um nome descritivo
  3. A chave será gerada com o prefixo cpk_sandbox_
Criar chave API

​
Chaves de Produção

Importante: Chaves de produção (cpk_prod_) só podem ser criadas após a validação completa dos documentos dentro da plataforma.

​
Processo para Chaves de Produção

  1. Validação de Documentos - Complete o processo de validação
  2. Aprovação da Conta - Aguarde a aprovação da nossa equipe
  3. Acesso Liberado - Após aprovação, o botão para criar chaves de produção será habilitado

​
Quando Usar Cada Tipo

SituaçãoChave Recomendada
Desenvolvimento e testescpk_sandbox_
Homologaçãocpk_sandbox_
Produção com transações reaiscpk_prod_

​
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.clickpay.app.br/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.clickpay.app.br/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:
  1. Crie chaves de produção na tela de gerenciamento
  2. Substitua as chaves em sua aplicação
  3. Atualize a URL base se necessário
  4. 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.