Bot do AfiliadoA 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
- Ative o módulo de API.
- No painel do bot, abra a aba API Keys.
- Dê um nome (opcional), escolha o nível de permissão e clique em Criar.
- Copie a chave completa — ela é exibida apenas uma vez.
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..."}'Níveis de permissão
Cada chave é criada com um nível, escolhido no painel. Ele limita o que aquela chave pode fazer na API (e nas ferramentas MCP, que passam pelos mesmos endpoints):
| Nível | Vale para | Endpoints |
|---|---|---|
Leitura (read) |
Consulta que não devolve link de afiliado | /api/v1/product/shipping, /product/history, /coupons (GET), /coupons/categories, /templates (GET), /showcase/items (GET), /bot, /userbot/config (GET), /userbot/history, /userbot/preview-rules |
Padrão (write) |
Leitura + operação do dia a dia | tudo de Leitura + /convert, /convert-links, /product, /execute, /chat, /search-products, /amazon-prices, /promo-card, /showcase/items (POST e DELETE) |
Total (admin) |
Tudo | tudo de Padrão + /coupons/ingest, /coupons/ingest-plugins, /coupons/{id} (DELETE), /coupons/{id}/activate, /templates (POST), /userbot/config (POST) |
Todo endpoint que devolve link de afiliado é Padrão, mesmo parecendo consulta: /product, /search-products e /amazon-prices geram/entregam link com a sua tag, que é exatamente o que uma chave de Leitura não deve fazer. Leitura fica com o que só informa — frete, histórico de preço, cupons e templates já cadastrados.
Ao conectar a IA por MCP com login (OAuth), sem colar chave, o nível vem do seu papel no workspace: owner/admin → Total, member → Padrão.
Uma chamada acima do nível da chave responde 403 com insufficient_scope:
{ "success": false, "error": "insufficient_scope" }O nível é escolhido na criação e pode ser trocado depois: na lista de chaves, a coluna Nível é um seletor. Trocar não rotaciona o segredo — a mesma chave continua valendo, com o novo nível já na chamada seguinte. Chaves criadas antes desta mudança continuam em Total até você rebaixá-las.
Use o menor nível que resolve: a chave que só lê preço no seu site não precisa poder apagar cupom.
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.
- Excluir — remove 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.
- Crie a chave no menor nível que atende à integração (ver Níveis de permissão).
- 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.