Référence API

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, lister, exporter en CSV/XLSX.
• Campaigns — créer, lire, mettre à jour, archiver les campagnes et consulter leurs stats.
• Affiliates — lister les affiliés, récupérer le détail, gérer l'affectation.
• Commissions — lister, approuver/rejeter en masse.
• Payouts — lister et créer des virements.
• Applications — accepter ou rejeter les candidatures d'affiliés, à l'unité ou en masse.
• Tracking — enregistrer des clics et identifier les visiteurs depuis le SDK.

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.

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.