Partenaires REST

Consultez le récapitulatif des performances du partenaire authentifié, vérifiez quels clients lui sont associés et suivez le markup généré par ses applications. Les endpoints marqués Beta peuvent être modifiés sans préavis.

Vue d'ensemble

Les APIs Partners permettent à une application de consulter les performances du partenaire authentifié, de confirmer qui lui appartient et de suivre ce que ses applications génèrent. Récapitulez les inscriptions, les gains du partenaire principal et l'activité de commission pour une période de reporting via l'endpoint analytics overview, confirmez quels identifiants clients sont associés au partenaire via l'endpoint client-tags check, et consultez le markup collecté par vos applications enregistrées via l'endpoint markup statistics. Ces trois appels sont des appels REST standard et nécessitent le scope OAuth2 application_read.

Flux de travail typique

1. Autorisez votre application pour la portée application_read, puis envoyez le token Bearer résultant avec chaque appel.
2. Consultez les cartes récapitulatives du partenaire avec GET /partners/analytics/v1/overview. Transmettez start_date et end_date au format YYYY-MM-DD pour définir la période de reporting inclusive, qui peut couvrir au maximum 730 jours.
3. Confirmez quels clients appartiennent au partenaire avec POST /partners/client-tags/check. Envoyez jusqu'à 100 identifiants dans client_ids et lisez is_tagged pour chacun d'eux dans la réponse.
4. Suivez ce que les applications enregistrées du partenaire ont généré avec GET /applications/v1/markup-statistics. Transmettez date_from et date_to au format YYYY-MM-DD en UTC pour définir la période de reporting, qui inclut les deux dates.

Points de terminaison disponibles

Authentification

Tous les endpoints nécessitent un en-tête Authorization: Bearer YOUR_OAUTH_TOKEN portant le scope application_read ; dans le cas contraire, l'API renvoie 403 Forbidden. Lors de l'authentification avec un Personal Access Token (PAT), l'en-tête Deriv-App-ID est également requis (voir Authentication).

Portées 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).

Codes de statut de réponse

L'API utilise des codes de statut HTTP standard pour indiquer le succès ou l'échec :

Format de réponse d'erreur

Toutes les réponses d'erreur suivent une enveloppe cohérente avec un tableau errors. Chaque entrée comporte un status numérique, un code lisible par machine et un message lisible par l'humain :

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