A API é construída com OpenAPI, então você pode explorar e testar os endpoints de forma interativa na referência Scalar.
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.
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 » |
Recursos
| Recurso | Caminho |
|---|---|
| Referência interativa (Scalar) | /docs/api/referencia/ |
| OpenAPI JSON (spec pública) | https://app.botdoafiliado.com/api/openapi.json |
💡 A spec OpenAPI é pública e pode ser importada no Postman/Insomnia ou usada para gerar clientes na sua linguagem (openapi-generator e afins).
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.