API conversions¶

La facturation et la consolidation des résultats du mois précédent supposent la mise à jour du statut de vos conversions (ventes ou leads). Cette étape est essentielle pour confirmer les conversions réelles et d'annuler celles qui n'ont pas abouti (retour produits, impayés, etc.)

L'API Effinity permet d'automatiser ce traitement en deux étapes : la récupération de la liste des conversions en attente et la mise à jour de leur statut.

Lister les conversions à traiter¶

Pour lister les conversions en attente, effectuez un appel en méthode GET sur l'URL de l'API.

https://prod.effiliation.com/apiv3/API_KEY/merchant/trn/pending

Paramètre	Définition	Exemple
`start`	Date de début au format yyyy-MM-dd	2026-01-01
`end`	Date de fin au format yyyy-MM-dd	2026-01-31

L'intervalle maximal par appel est de 90 jours

Statut des conversions

La dernière partie de l'URL pending peut être modifiée pour filtrer les résultats selon vos besoins :

Remplacer par valid pour récupérer les conversions validées ;
Remplacer par cancel pour récupérer les conversions annulées.

Exemple de réponse

[
    {
        "logid":"ffd0a1be4a7e12498e15a9d1a171cf5fd613c3538ccf1ad4d6cfb0980a7ae351",
        "ref":"MY_REF",
        "status":"PENDING",
        "date":"2023-08-18 00:00:00.0",
        "amount":5.00000,
        "commission":1.00000,
        "mea":0.50000,
        "nomsite":"affilie.fr",
        "url":"https://www.affilie.fr",
        "typeaffilie":"subnetwork",
        "transactionType":"SELL"
    },
...
]

Valider ou annuler les conversions¶

Traiter par lot (recommandé)¶

Pour traiter plusieurs conversions simultanément, utilisez un appel POST.

https://prod.effiliation.com/apiv3/API_KEY/merchant/trn/updates

Exemple de requête

[
    {
        "logid":"ffd0a1be4a7e12498e15a9d1a171cf5fd613c3538ccf1ad4d6cfb0980a7ae351",
        "status":"VALID",
        "amount":5.00000,
    },
...
]

Traiter unitairement¶

Pour traiter une conversion, utilisez un appel POST.

https://prod.effiliation.com/apiv3/API_KEY/merchant/trn/updates

Réponses¶

Code	Libellé	Définition
`200`	Conversion :`logid` has been updated to status `status`	Votre conversion a été correctement mise à jour. Voir exemple ci-dessous
`400`	Wrong API key	L'API key dans l'url n'est pas valide
`400`	Status Not Found : `status`, need to be : `VALID` or `CANCEL`	La valeur du statut que vous utilisez n'est pas une des 2 valeurs possibles 'VALID' ou 'CANCEL'
`404`	Conversion Not Found	Le logid (identifiant unique) n'est pas valide
`500`	`amount` is not allowed as amount of conversion	Le montant envoyé dans la conversion, n'est pas un nombre ou est négatif
`500`	Conversion : `logId` is not in pending status	La conversion a déjà été traitée, elle n'est plus en attente
`500`	Cancel rate limit reached	La conversion ne peut être annulée car vous avez atteint le taux d'annulation maximal autorisé
`500`	Unknown error	Erreur inconnue

Exemple de réponse 200

[
    {
    "logid": "ffd0a1be4a7e12498e15a9d1a171cf5fd613c3538ccf1ad4d6cfb0980a7ae351",
    "code": "status-updated",
    "message": "Conversion :'ffd0a1be4a7e12498e15a9d1a171cf5fd613c3538ccf1ad4d6cfb0980a7ae351' has been updated to status 'VALID'"
    }
]