Spark!

Endpoints REST

Referência dos endpoints da API do Spark!

Última atualização: 2026-01-19

A API REST do Spark! oferece acesso por programação a afiliados, pedidos, comissões e mais. Todos os endpoints retornam JSON.

URL base

https://api.chargezen.com/spark/v1

Afiliados

  • GET /affiliates — Listar todos os afiliados
  • GET /affiliates/:id — Obter afiliado por ID
  • POST /affiliates — Criar afiliado
  • PUT /affiliates/:id — Atualizar afiliado
  • DELETE /affiliates/:id — Excluir afiliado

Pedidos

  • GET /orders — Listar pedidos atribuídos
  • GET /orders/:id — Obter pedido por ID
  • POST /orders/:id/attribute — Atribuir pedido manualmente

Comissões

  • GET /commissions — Listar todas as comissões
  • GET /commissions/:id — Obter comissão por ID
  • PUT /commissions/:id/approve — Aprovar comissão pendente
  • PUT /commissions/:id/reject — Rejeitar comissão pendente

Pagamentos

  • GET /payouts — Listar todos os pagamentos
  • GET /payouts/:id — Obter pagamento por ID
  • POST /payouts — Criar pagamento manual
  • GET /links — Listar links de rastreamento
  • GET /links/:id — Obter link por ID
  • POST /links — Criar link de rastreamento
  • DELETE /links/:id — Excluir link

Análises

  • GET /analytics/summary — Resumo de desempenho
  • GET /analytics/affiliates — Métricas por afiliado
  • GET /analytics/products — Métricas por produto
  • GET /analytics/clicks — Dados por clique
Paginação

Os endpoints de listagem aceitam paginação pelos parâmetros de consulta page e per_page. O padrão é 25 itens por página, com máximo de 100.

Filtros e ordenação

Os endpoints de listagem aceitam:

  • ?status=active — Filtrar por status
  • ?created_after=2024-01-01 — Filtros de data
  • ?sort=created_at — Campo de ordenação
  • ?order=desc — Direção da ordenação

Próximos passos

Esta página foi útil?

Precisa de mais ajuda? Fale com o suporte