Skip to main content

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

Ambiente de produção:
  • 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

  1. Acesse o Dashboard do Affiliatus
  2. Vá em ConfiguraçõesAPI Keys
  3. Clique em “Nova API Key”
  4. Copie a chave (será exibida apenas uma vez!)

Enviando a API Key

Inclua sua API key no header X-API-Key de todas as requisições:
Segurança: Nunca exponha sua API key no frontend ou em repositórios públicos. Use variáveis de ambiente ou gerenciadores de secrets.

Rate Limiting

A API possui limites de requisições para garantir estabilidade: Headers de resposta:
Resposta quando limite excedido (429):
Implemente retry com exponential backoff para lidar com rate limits de forma elegante.

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


Erros

Estrutura de Erro

Erros Comuns

401 - API Key Inválida

Solução: Verifique se o header X-API-Key está presente e correto.

403 - API Key Revogada

Solução: Crie uma nova API key no dashboard.

400 - Dados Inválidos

Solução: Verifique se todos os campos obrigatórios estão presentes e válidos.

Endpoints Disponíveis

Enviar Eventos

Envie conversões e outros eventos de rastreamento via POST

Exemplo Rápido

Enviar uma Conversão

Resposta (200 OK):

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?

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