Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Où insérer l'ID de votre organisation
Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X POST https://api.zinndigital.com/v1/affiliate \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "commission_plan": <string<recurring_12m, lifetime>>, "payout_destination": <string<wallet, cash>>, "accept_terms": <boolean> }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
Gated on `affiliate.manage`. The account lands `pending` and accrues nothing until staff approve it — otherwise the programme is an open invitation to self-refer at scale. Choosing cash payouts sets `kyc_state` to `required`; wallet credit needs no verification because the money never leaves the platform.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
org_id (query) | string | Non | — |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
commission_plan | string<recurring_12m, lifetime> | Oui | — |
payout_destination | string<wallet, cash> | Oui | — |
accept_terms | boolean | Oui | Must be `true`. An affiliate agreement is a contract about money, so acceptance is recorded explicitly rather than assumed. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | string | Oui | — |
org_id | string | Oui | — |
state | string<pending, approved, rejected, suspended> | Oui | — |
code | string | Oui | The referral code. Its alphabet excludes the characters people transcribe wrongly (`0`/`O`, `1`/`I`/`l`), because it is read aloud and typed off a slide. |
referral_url | string | Oui | The link to share — the public site with `?ref=CODE`. |
commission_plan | string<recurring_12m, lifetime> | Oui | The line **new** referrals will be created on. Changing it never affects customers already referred. |
payout_destination | string<wallet, cash> | Oui | — |
kyc_state | string<not_required, required, submitted, verified, rejected> | Oui | — |
review_note | string | Non | — |
terms_accepted_at | string | Non | — |
applied_at | string | Non | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 409 · 422