Como gerar e gerenciar sua API Key
A API Key é uma chave de autenticação que permite conectar aplicações externas à Pingback. Com ela, você pode criar integrações personalizadas, automatizar processos e conectar a Pingback com suas ferramentas favoritas.
Importante: É necessário ter um plano pago da Pingback (Pro ou Ultra) para gerar e usar API Keys. O plano Free não tem acesso a essa funcionalidade.
Como acessar a página de API Key
No menu lateral, clique no seu perfil
Selecione Informações da conta
Clique na aba API Key
Acesse diretamente: pingback.com/publish/settings/account/api-key
Se você ainda não criou nenhuma API Key, verá um estado vazio com a mensagem "Nenhuma API Key gerada" e o botão para criar a primeira.
Como criar sua primeira API Key
Passo 1: Inicie a criação
Clique no botão "+ Nova API Key"
Um modal será aberto
Passo 2: Nomeie sua API Key
Digite um nome descritivo no campo "Nome"
Use nomes que ajudem a identificar onde será usada
Exemplos: "Integração CRM", "App Mobile", "Automação Interna"
Clique em "Gerar API Key"
Passo 3: API Key criada
Sua API Key será gerada instantaneamente e ficará visível na listagem com status "Ativo".
Limitação importante
Apenas 1 API Key por conta.
Você pode criar somente uma API Key por conta Pingback. Se precisar de uma nova, será necessário excluir a existente antes.
Essa limitação garante melhor controle e segurança do acesso à sua conta.
Como usar sua API Key
Localize sua API Key na listagem
O token ficará oculto por padrão (exibido como
••••••••••••••••••••)Clique no ícone de "Revelar" (olho) para visualizar o token completo
Clique no ícone de "Copiar" para copiar o token
Usando na API:
Após copiar, use o token no header de autenticação das suas requisições à API da Pingback:
x-api-key: {SEU_TOKEN_AQUI}Consulte a documentação completa da API para ver todos os endpoints disponíveis e exemplos de uso.
Como gerenciar sua API Key
Clique no menu de três pontos (⋮) ao lado da API Key para acessar as opções:
Desativar:
Suspende temporariamente o acesso da API Key
Todas as requisições usando essa chave serão bloqueadas
Útil quando você suspeita que a chave foi comprometida mas não quer excluir ainda
Status muda para "Desativado"
Para reativar, clique novamente no menu e selecione "Ativar"
Renomear:
Altere o nome da API Key para melhor organização
Não afeta o funcionamento ou o token
Útil quando você muda o uso ou a aplicação que utiliza a chave
Excluir:
Remove permanentemente a API Key
Atenção: Todas as integrações usando essa chave irão parar de funcionar imediatamente
Não é possível recuperar uma API Key excluída
Você precisará criar uma nova e atualizar todas as integrações
Segurança e boas práticas
Nunca compartilhe sua API Key
IMPORTANTE: Trate sua API Key como uma senha.
Não compartilhe em:
Repositórios públicos no GitHub, GitLab, etc
Mensagens em grupos ou chats públicos
Screenshots ou vídeos que serão compartilhados
Código-fonte versionado sem criptografia
Quem tem acesso à sua API Key tem controle total sobre sua conta Pingback via API.
Armazene com segurança
Onde guardar:
Variáveis de ambiente (.env) nunca versionadas
Gerenciadores de secrets (AWS Secrets Manager, Vault, etc)
Ferramentas de gestão de credenciais da sua empresa
Onde NÃO guardar:
Direto no código-fonte
Arquivos de configuração versionados
Planilhas ou documentos compartilhados
Notas não criptografadas
Se suspeitar de vazamento
Ação imediata:
Exclua a chave comprometida
Gere uma nova API Key
Atualize todas as suas integrações legítimas
Prevenção:
Revise regularmente onde sua API Key está sendo usada
Mantenha registros das integrações ativas
Use monitoramento de requisições suspeitas
Rotação periódica
Considere renovar sua API Key periodicamente (a cada 6-12 meses) como medida preventiva de segurança:
Crie uma nova API Key
Atualize todas as integrações com a nova chave
Teste se tudo está funcionando
Exclua a chave antiga
Documentação da API
Para usar sua API Key em integrações, consulte nossa documentação técnica completa:
A documentação inclui:
Endpoints disponíveis
Exemplos de requisições
Formato de resposta
Rate limits
Códigos de erro
Casos de uso comuns
Integração com CRM: Sincronize contatos entre Pingback e seu CRM automaticamente
App mobile customizado: Crie aplicativos que enviem dados da Pingback
Automações avançadas: Conecte Pingback com ferramentas internas da empresa
Perguntas frequentes
Posso ter mais de uma API Key?
Não. Cada conta Pingback pode ter apenas uma API Key ativa por vez.
A API Key expira?
Não. Uma vez criada, a API Key permanece válida até que você a exclua ou desative.
Preciso de plano pago para usar API?
Sim. API Keys estão disponíveis apenas nos planos Pro e Ultra.
O que acontece se eu mudar de plano?
Se você fizer downgrade para Free, sua API Key será desativada automaticamente.
Precisa de ajuda? Entre em contato pelo chat ou email em suporte@getpingback.com