Parceiros REST

Leia o resumo de desempenho do parceiro autenticado, verifique quais os clientes associados ao mesmo e acompanhe o markup que as suas aplicações ganham. Os endpoints marcados como Beta podem ser alterados sem aviso prévio.

Visão Geral

As APIs de Parceiros permitem que uma aplicação leia o desempenho do parceiro autenticado, confirme quem lhe pertence e acompanhe o que as suas aplicações ganham. Resuma as inscrições, os ganhos do parceiro principal e a atividade de comissões referentes a um período de relatório através do endpoint analytics overview, confirme quais dos seus IDs de cliente estão associados ao parceiro através do endpoint client-tags check e leia o markup que as suas aplicações registadas recolheram através do endpoint markup statistics. As três são chamadas REST padrão e requerem o âmbito OAuth2 application_read.

Fluxo de Trabalho Típico

1. Autorize a sua aplicação para o âmbito application_read e, em seguida, envie o Bearer token resultante em cada chamada.
2. Leia os cartões de resumo do parceiro com GET /partners/analytics/v1/overview. Passe start_date e end_date no formato AAAA-MM-DD para definir o período de relatório inclusivo, que pode abranger no máximo 730 dias.
3. Confirme quais dos seus clientes pertencem ao parceiro com POST /partners/client-tags/check. Envie até 100 IDs em client_ids e leia is_tagged para cada um na resposta.
4. Acompanhe o que as aplicações registadas do parceiro ganharam com GET /applications/v1/markup-statistics. Passe date_from e date_to no formato AAAA-MM-DD em UTC para definir o período de relatório, que inclui ambas as datas.

Endpoints Disponíveis

Autenticação

Todos os endpoints requerem um cabeçalho Authorization: Bearer YOUR_OAUTH_TOKEN com o âmbito application_read; caso contrário, a API devolve 403 Forbidden. Ao autenticar com um Token de Acesso Pessoal (PAT), o cabeçalho Deriv-App-ID também é obrigatório (consulte Authentication).

Âmbitos OAuth2

1curl -X GET "https://api.derivws.com/partners/analytics/v1/overview?start_date=2026-07-01&end_date=2026-07-21" \
2  -H "Authorization: Bearer YOUR_OAUTH_TOKEN"
3# Add -H "Deriv-App-ID: YOUR_APP_ID" when authenticating with a Personal Access Token (PAT).

Códigos de Estado da Resposta

A API usa códigos de estado HTTP padrão para indicar sucesso ou falha:

Formato de Resposta de Erro

Todas as respostas de erro seguem um envelope consistente com um array errors. Cada entrada contém um status numérico, um code legível por máquina e uma message legível por humanos:

1{
2  "errors": [
3    {
4      "status": 422,
5      "code": "ValidationError",
6      "message": "end_date must be on or after start_date"
7    }
8  ]
9}