Référence API
Parcourez chaque endpoint public avec des exemples de requête/réponse en direct et un playground try-it-out.
La référence est générée automatiquement depuis le spec OpenAPI 3.1 en direct sur
app.refcampaign.com/api/openapi.json
— pas de YAML manuel à maintenir, donc pas de dérive avec le code.
Les endpoints sont regroupés par tag dans la barre latérale :
- Conversions — suivre les conversions serveur-à-serveur, rembourser les conversions postback, lister et résumer les conversions.
- Campaigns — lister les campagnes et récupérer le détail d'une campagne.
- Affiliates — lister les affiliés et récupérer le détail d'un affilié.
- Assets — lister les assets marchands finalisés, créer des swipe copy, mettre à jour les métadonnées, archiver.
- Commissions — lister, approuver/rejeter en masse.
- Applications — accepter ou rejeter les candidatures d'affiliés, à l'unité ou en masse.
- Dashboard — récupérer les KPI marchands.
- Payouts — lister, créer, approuver, rejeter et marquer les paiements comme payés.
- System — valider une clé d'intégration avec l'endpoint ping.
Chaque page d'opération inclut :
- Le schéma complet de la requête (path params, query params, body JSON) avec marqueurs requis/optionnels.
- Un tableau de réponse par code de statut avec la forme du body JSON.
- Des exemples de code en cURL, JavaScript (
fetch) et Python (requests). - Un playground try-it-out qui passe la requête par le proxy de transfert de ce site, pour que les règles CORS du navigateur ne bloquent pas la réponse.
Référence en anglais uniquement
Le contenu généré (descriptions de schémas, noms de champs) reste en anglais — c'est le langage de l'API elle-même. La navigation, la barre latérale et la recherche sont traduites.
Authentification
Toutes les requêtes s'authentifient avec un token Bearer. Générez-en un dans le tableau de bord sous Paramètres → Clés API et passez-le sur chaque requête :
Authorization: Bearer <VOTRE_TOKEN>Le playground expose un champ Authorization en haut de chaque opération —
collez le token pour tester l'endpoint en direct contre
app.refcampaign.com.
Erreurs
Toute erreur renvoie une forme JSON cohérente :
{
"error": {
"code": "VALIDATION_FAILED",
"message": "currency must be a 3-letter ISO 4217 code",
"details": { "field": "currency" }
}
}Voir gestion des erreurs pour la référence complète des codes.
Totaux monétaires par devise
GET /api/v1/dashboard/summary renvoie totals.revenueTotals et
totals.commissionTotals. Le détail d’un affilié renvoie ces mêmes tableaux
dans chaque participation. Chaque entrée contient un code ISO currency et
un montant amount sous forme de chaîne décimale, dans l’unité principale de
la devise. Exemple : [{"currency":"EUR","amount":"12.34"},{"currency":"JPY","amount":"500"}].
Les tableaux sont triés par code ISO. Un tableau vide signifie qu’aucune
écriture n’est présente ; un zéro conserve sa devise. Aucune conversion de
devises n’est appliquée. La synthèse ne renvoie plus les scalaires revenue et commissions, et les
participations ne renvoient plus totalRevenue et totalCommissions. Les outils MCP de synthèse et de
détail d’affilié affichent également chaque devise séparément.
Gestion des erreurs
Forme de la réponse d'erreur, codes courants et stratégie de retry.
Track a server-to-server postback conversion POST
Records a cookieless conversion from a merchant server. Use `affiliateCode` for explicit server-side code attribution when no click is available. Use `sessionId` returned by the consent-gated SDK flow when available. Use `clickId` only when the integration has the real click id; otherwise pass a `customerEmailHash` or `customerEmail` for email-hash fallback matching.