> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pulse-sell.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Affiliés

> Lire vos affiliés, vérifier un code de parrainage et consulter les commissions.

Vos affiliés promeuvent vos produits avec un lien qui leur est propre. L'API vous donne une vue en lecture seule de leur activité **sur votre boutique**.

> [!NOTE]
>
> Permission : `affiliates.read`. Référence : [Affiliés](https://docs.pulse-sell.com/api-reference/affilies).

## Qui est "mon affilié" ?

Un affilié apparaît dès qu'il a généré au moins un lien vers l'un des produits de votre boutique. Ses chiffres (visites, ventes, revenus, gains) ne comptent que **vos** produits : ce qu'il fait pour d'autres vendeurs ne vous est jamais montré.

## Lister

```bash theme={null}
curl "https://api.pulse-sell.com/v1/affiliates?status=active" \
  -H "Authorization: Bearer $PULSESELL_API_KEY"
```

```json theme={null}
{
  "id": "cm1aff001",
  "code": "AWA10",
  "status": "active",
  "name": "Awa",
  "country": "CI",
  "total_visits": 240,
  "total_sales": 12,
  "total_revenue": { "value": 240000, "currency": "XOF" },
  "total_earnings": { "value": 24000, "currency": "XOF" },
  "commission_rate": 0.1,
  "first_visit_at": "2026-09-02T09:00:00.000Z",
  "last_visit_at": "2026-10-29T14:00:00.000Z",
  "joined_at": "2026-09-01T10:00:00.000Z"
}
```

`commission_rate` est une fraction : `0.1` signifie 10 %.

## Vérifier un code de parrainage

`GET /affiliates/{id}` accepte l'identifiant **ou le code de parrainage** : utile pour valider un code saisi dans votre propre formulaire.

```bash theme={null}
curl https://api.pulse-sell.com/v1/affiliates/AWA10 \
  -H "Authorization: Bearer $PULSESELL_API_KEY"
```

Si le code n'appartient pas à un affilié de votre boutique : `404`.

## Commissions

```bash theme={null}
curl "https://api.pulse-sell.com/v1/affiliates/AWA10/commissions" \
  -H "Authorization: Bearer $PULSESELL_API_KEY"
```

Chaque commission indique la commande, le montant de la vente, la commission et son statut (`pending`, `approved`, `paid`…). Elles sont triées de la plus récente à la plus ancienne.

## Protection des données de vos affiliés

Par choix, l'API n'expose **ni l'adresse e-mail, ni le solde, ni les retraits** d'un affilié. Vous avez ce qu'il faut pour piloter vos ventes, rien qui permette de démarcher vos partenaires en dehors de la plateforme.

## Savoir quand un affilié arrive

L'événement [`affiliate.joined`](https://docs.pulse-sell.com/pulses/events#affiliate-joined) est envoyé quand un affilié génère son premier lien pour l'un de vos produits.

> [!NOTE]
>
> L'invitation d'affiliés par API n'existe pas encore : elle sera ajoutée avec la fonctionnalité d'invitation du tableau de bord, pas avant.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.