API REST do RastroAff: chaves, permissões, endpoints e limites

A API REST dá acesso por programa ao que vês no painel. Está incluída a partir do plano Starter.

Criar uma chave

No menu API, cria uma chave. Escolhe se pode só ler ou também escrever, e um prazo de validade, se quiseres. A chave (começa por rst_) só aparece uma vez: guarda-a num sítio seguro. Podes revogá-la a qualquer momento.

Usa-a no cabeçalho de cada pedido:

curl https://rastroaff.com/api/v1/me -H "Authorization: Bearer rst_..."

O que cada chave vê

A chave tem o tipo e o âmbito da conta que a criou:

• Administrador: toda a rede.
• Gestor: os afiliados que lhe estão atribuídos.
• Anunciante: as suas campanhas; pode registar conversões e enviar a atividade dos jogadores.
• Afiliado: o seu tráfego, os seus ganhos e os seus pagamentos.

As contas de administrador precisam de autenticação de dois fatores ativa para usar a API.

Endpoints

• /api/v1/campaigns: listar, criar, editar e mudar o estado das ofertas.
• /api/v1/affiliates e /api/v1/advertisers: listar, ver, editar, aprovar.
• /api/v1/clicks e /api/v1/conversions: listar e, para os anunciantes, registar conversões.
• /api/v1/reports: o mesmo motor dos relatórios do painel.
• /api/v1/payouts: pedidos de pagamento e o seu estado.
• /api/v1/postbacks: o registo dos postbacks enviados.

A especificação completa (OpenAPI 3.1) está em /api/v1/openapi.json, na língua do pedido.

Limites e erros

• 600 pedidos por minuto por chave. Os cabeçalhos X-RateLimit-* dizem quanto falta; acima do limite, a resposta é 429.
• Os erros vêm em JSON com um código (unauthorized, insufficient_scope, validation_error…) e uma mensagem.

Para receber eventos em vez de os ir buscar, usa webhooks.