Bot do Afiliado

Autenticação na API: como usar a API key (X-API-Key)

Como gerar e usar API keys do Bot do Afiliado, autenticar com o header X-API-Key e revogar ou excluir chaves no painel. Requer o módulo de API.

Nesta página

A API usa API keys geradas no painel. Cada chave tem o formato bk_<prefixo>.<segredo> e é enviada no header X-API-Key. O recurso exige o módulo de API ativo.

Gerar uma chave

  1. Ative o módulo de API.
  2. No painel do bot, abra a aba API Keys.
  3. Clique em Criar e dê um nome (opcional).
  4. Copie a chave completa — ela é exibida apenas uma vez.
Aba API e IA MCP do painel: campo de nome, botão Criar e a lista de chaves com NOME e PREFIXO

Usar nas chamadas

curl -X POST "https://botdoafiliado.com/api/v1/convert-links" \
  -H "content-type: application/json" \
  -H "X-API-Key: bk_xxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -d '{"url":"https://www.aliexpress.com/item/100500..."}'

Revogar ou excluir

Na aba API Keys, cada chave tem duas ações:

  • Revogar — desativa a chave (efeito imediato), mas mantém o registro na lista (útil para auditoria/histórico). Não dá para reativá-la.
  • Excluirremove a chave de vez da lista. Chaves já revogadas também podem ser excluídas para limpar a lista.

Segurança

  • A chave completa não fica armazenada em texto puro — o painel guarda apenas um hash e mostra o prefixo.
  • Revogue ou exclua chaves comprometidas na aba API Keys (efeito imediato).
  • Nunca exponha a chave no front-end; use-a apenas no servidor.

Próximo: faça sua primeira conversão em convert-links.

Perguntas frequentes

A API key (X-API-Key) do Bot do Afiliado aparece de novo depois de criada?

Não. A chave completa é exibida apenas no momento da criação. Depois, o painel mostra só o prefixo. Guarde-a com segurança.

Como revogar ou excluir uma API key do Bot do Afiliado no painel?

Na aba API Keys, use Revogar para desativar a chave (ela continua na lista, desativada) ou Excluir para removê-la de vez. Nos dois casos a chave deixa de funcionar imediatamente.

Posso ter várias API keys (X-API-Key) para a mesma API do Bot do Afiliado?

Sim. Crie chaves separadas por integração/sistema e revogue individualmente quando necessário.

Preciso enviar bot_id junto com a X-API-Key nas chamadas da API REST?

Não. O bot é sempre identificado pela X-API-Key — o campo bot_id (se enviado) é ignorado, e a chave é obrigatória. Para uso direto no navegador (sites/widgets), use uma Embed Key travada por domínio, não a X-API-Key.

Pronto para automatizar suas comissões?

Crie seu bot, conecte suas integrações e comece a converter links em segundos.