L'API PartnerCut

Vous déclarez vos revenus, la plateforme calcule ce que vous devez à vos ambassadeurs, produit leurs factures et le fichier de virement. Une seule intégration compte vraiment : POST /api/v1/events. Le reste est du confort.

La plateforme ne détient jamais vos fonds ni ceux de vos ambassadeurs. Elle calcule, elle facture, elle produit un fichier SEPA. C'est vous qui payez, depuis votre compte. Aucun appel de cette API ne déplace d'argent.

Par où commencer

Ce que fait PartnerCut

Les six notions qui suffisent à tout comprendre, et l'ordre dans lequel elles s'enchaînent.

Votre première commission

De la clé d'API à une commission calculée, en quatre appels.

Clés d'API et portées

Comment s'authentifier, ce qu'une clé donne le droit de faire, et quoi faire quand elle fuit.

Signature HMAC

Le second verrou, facultatif mais recommandé, qui protège du rejeu et de l'altération.

Erreurs et limites

Le format des erreurs, ce que chaque code signifie, et les quotas.

Référence

Revenus

Le seul appel qui alimente la comptabilité. Si vous n'en intégrez qu'un, c'est celui-là.

Appel	Ce qu'il fait	Portée
POST /api/v1/events	Remonter un revenu Déclare une transaction. La plateforme cherche l'ambassadeur qui a amené ce client, applique le barème du programme, et enregistre la commission.	events:write
GET /api/v1/events/{externalId}	Relire un revenu Demande « celui-ci est-il bien arrivé ? » sans rejouer l'écriture.	commissions:read

Clients

Rattacher un client à l'ambassadeur qui l'a amené, et vérifier ce rattachement.

Appel	Ce qu'il fait	Portée
POST /api/v1/customers/attribute	Rattacher un client Déclare qu'un client vient d'un ambassadeur. À appeler à l'inscription, avec le code lu dans l'URL ou dans le cookie posé par le SDK.	customers:write
GET /api/v1/customers/{customerId}	Vérifier un rattachement Ce client est-il parrainé, et par qui ?	customers:read

Suivi

Lire ce que la plateforme a calculé, pour l'afficher chez vous ou le rapprocher.

Appel	Ce qu'il fait	Portée
GET /api/v1/commissions	Lister les commissions Ce que la plateforme a calculé pour votre projet, avec le détail du calcul.	commissions:read
GET /api/v1/partnerships	Lister les ambassadeurs Les ambassadeurs de votre projet et leurs codes, pour les afficher chez vous.	partnerships:read

Ce qui ne changera pas sous vos pieds

L'API est versionnée. /api/v1 ne recevra jamais de changement incompatible. Un retrait de version serait annoncé six mois à l'avance.
Les montants sont des entiers de centimes. Jamais de nombre à virgule, dans aucun sens : 12,34 € s'écrit et se lit 1234.
Les taux sont en points de base. 5 % s'écrit 500, 0,25 % s'écrit 25.
Un revenu déclaré n'est jamais perdu. Même quand rien ne peut être commissionné — client inconnu, aucune règle applicable — l'événement est enregistré avec sa raison. Vous n'avez rien à rejouer plus tard.