---
title: "Endpoints REST: documentação do Spark! | Chargezen"
description: "Referência dos endpoints da API do Spark!. Da seção Referência da API da documentação do Spark! da Chargezen."
url: "https://chargezen.com/pt-br/docs/spark/api/endpoints"
lang: "pt-BR"
updated: "2026-01-19"
---

Canonical URL: https://chargezen.com/pt-br/docs/spark/api/endpoints

# 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

## Links de rastreamento

*   `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

[

### Webhooks

Notificações de eventos em tempo real

Saiba mais



](https://chargezen.com/pt-br/docs/spark/api/webhooks)[

### Autenticação

Guia de autenticação da API

Saiba mais



](https://chargezen.com/pt-br/docs/spark/api/authentication)

### Artigos relacionados

[

#### Autenticação

Autenticação da API



](https://chargezen.com/pt-br/docs/spark/api/authentication)[

#### Webhooks

Notificações de eventos



](https://chargezen.com/pt-br/docs/spark/api/webhooks)

Esta página foi útil?

Precisa de mais ajuda? [Fale com o suporte](https://chargezen.com/pt-br/docs/checkoutos/troubleshooting/support)