A referência interativa da API do Bot do Afiliado fica em /docs/api/referencia/, no Scalar, e lê o contrato público https://botdoafiliado.com/api/openapi.json. O contrato não pede login; testar um endpoint pede a sua API key.
Referência interativa da API
👉 Abrir a referência da API (Scalar) »
A referência Scalar tem busca (atalho Ctrl+K), schemas de request/response, exemplos de código (cURL por padrão; troque para JavaScript, Python, PHP e outros no seletor) e try it out direto no navegador. A página monta o conteúdo no navegador: sem JavaScript, use o JSON abaixo.
Atalhos por seção
| Seção | O que tem | Link direto |
|---|---|---|
| Conversão | convert-links, convert (legado) |
abrir » |
| Produtos | product, product/history, product/shipping, search-products, amazon-prices |
abrir » |
| Ofertas | execute (post pronto), chat, templates |
abrir » |
| Cupons | listar, cadastrar, desativar/reativar, categorias, ingestão | abrir » |
O contrato OpenAPI
| O quê | Valor |
|---|---|
| Endereço | https://botdoafiliado.com/api/openapi.json |
| Login | nenhum |
| CORS | access-control-allow-origin: *, métodos GET e OPTIONS |
| Cache | public, max-age=300 (5 minutos) |
| Autenticação declarada | ApiKeyAuth, header X-API-Key |
💡 Importe o contrato no Postman/Insomnia ou use-o para gerar clientes na sua linguagem (openapi-generator e afins).
E o /swagger?
O /swagger e o /swagger-data são a documentação interna da API: só abrem com sessão do painel (ou a senha do ambiente) e respondem 401 para o público. Robôs e agentes de IA não devem usá-los: o robots.txt os fecha e o llms.txt aponta para a referência pública.
Como usar
- Abra a referência Scalar para ver os schemas de request/response.
- Autentique com a sua API key (
X-API-Key): na referência, use o campo Auth no topo para preenchê-la uma vez e testar qualquer endpoint. - Teste os endpoints convert-links e product.