Partners REST

Lea el resumen de rendimiento del socio autenticado, compruebe qué clientes están etiquetados a él y realice un seguimiento del margen que ganan sus aplicaciones. Los endpoints marcados como Beta pueden modificarse sin previo aviso.

Descripción general

Las APIs de Partners permiten que una aplicación lea el rendimiento del socio autenticado, confirme quiénes pertenecen a él y realice un seguimiento de lo que ganan sus aplicaciones. Resuma los registros, las ganancias del socio principal y la actividad de comisiones de un período de informes a través del endpoint analytics overview, confirme qué ID de cliente están etiquetados al socio a través del endpoint client-tags check y lea el margen que recaudaron sus aplicaciones registradas a través del endpoint markup statistics. Las tres son llamadas REST estándar y requieren el alcance OAuth2 application_read.

Flujo de trabajo típico

1. Autorice su aplicación para el alcance application_read y, a continuación, envíe el token Bearer resultante con cada llamada.
2. Lea las tarjetas de resumen del socio con GET /partners/analytics/v1/overview. Pase start_date y end_date en formato YYYY-MM-DD para establecer el período de reporte inclusivo, que puede abarcar un máximo de 730 días.
3. Confirme cuáles de sus clientes pertenecen al socio con POST /partners/client-tags/check. Envíe hasta 100 IDs en client_ids y lea is_tagged para cada uno en la respuesta.
4. Realice un seguimiento de lo que ganaron las aplicaciones registradas del socio con GET /applications/v1/markup-statistics. Introduzca date_from y date_to en formato YYYY-MM-DD en UTC para establecer el período de informes, el cual incluye ambas fechas.

Endpoints Disponibles

Autentificación

Todos los endpoints requieren un encabezado Authorization: Bearer YOUR_OAUTH_TOKEN que contenga el alcance application_read; de lo contrario, la API devuelve 403 Forbidden. Al autenticarse con un Token de Acceso Personal (PAT), el encabezado Deriv-App-ID también es obligatorio (consulte Authentication).

Alcances de 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 de respuesta

La API utiliza códigos de estado HTTP estándar para indicar éxito o fallo:

Formato de respuesta de error

Todas las respuestas de error siguen un formato consistente con un array errors. Cada entrada contiene un status numérico, un code legible por máquina y un message legible 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}