Bem-vindo à API do Affiliatus
A API do Affiliatus permite que você integre seu sistema de afiliados diretamente com seu backend, possibilitando enviar conversões, gerenciar afiliados e acessar métricas programaticamente.Base URL
- Base URL:
https://api.affiliatus.io - Versão: v1 (atual)
Autenticação
Todas as requisições à API requerem autenticação via API Key.Como Obter sua API Key
- Acesse o Dashboard do Affiliatus
- Vá em Configurações → API Keys
- Clique em “Nova API Key”
- Copie a chave (será exibida apenas uma vez!)
Enviando a API Key
Inclua sua API key no headerX-API-Key de todas as requisições:
Rate Limiting
A API possui limites de requisições para garantir estabilidade:| Endpoint | Limite | Período |
|---|---|---|
/v1/events | 70 requisições | por minuto |
/v1/sdk/events | 70 requisições | por minuto |
| Outros endpoints | 100 requisições | por minuto |
Formatos de Dados
Request
- Content-Type:
application/json - Encoding: UTF-8
- Date Format: ISO 8601 (
2024-01-15T10:30:00Z)
Response
Todas as respostas são em formato JSON:Códigos de Status HTTP
| Código | Descrição | Uso |
|---|---|---|
| 200 | OK | Requisição bem-sucedida |
| 201 | Created | Recurso criado com sucesso |
| 400 | Bad Request | Dados inválidos ou faltando |
| 401 | Unauthorized | API key inválida ou ausente |
| 403 | Forbidden | API key revogada ou sem permissão |
| 404 | Not Found | Recurso não encontrado |
| 429 | Too Many Requests | Rate limit excedido |
| 500 | Internal Server Error | Erro no servidor |
Erros
Estrutura de Erro
Erros Comuns
401 - API Key Inválida
X-API-Key está presente e correto.
403 - API Key Revogada
400 - Dados Inválidos
Endpoints Disponíveis
Enviar Eventos
Envie conversões e outros eventos de rastreamento via POST
Exemplo Rápido
Enviar uma Conversão
SDKs e Bibliotecas
Atualmente, a API suporta requisições HTTP diretas em qualquer linguagem. Exemplos disponíveis:- Node.js (Fetch, Axios)
- PHP (cURL)
- Python (Requests)
- Ruby (Net::HTTP)
- Go (net/http)
Veja exemplos completos na documentação de integração.
Versionamento
A API segue versionamento semântico. A versão atual é v1. Breaking changes serão comunicadas com antecedência e uma nova versão será disponibilizada.Suporte
Precisa de ajuda?- Email: suporte@affiliatus.io
- Guia de Integração: /integrations/api-rest
- Quickstart: /quickstart
Próximos Passos
Ver Endpoints
Explore todos os endpoints disponíveis
Guia de Integração
Tutorial completo com exemplos de código
Criar API Key
Gere sua primeira API key no dashboard
Testar API
Faça seu primeiro teste com cURL

