Contents
POST généré un lien de tracking
Authentification
Générer une URL de tracking unique
Générer plusieurs URL de tracking
Récupération du quota de liens courts
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
POST générer un lien de tracking
Les éditeurs peuvent afficher une URL de destination pour un annonceur afin de générer un lien de tracking Awin. Ce endpoint vous permet de générer un seul lien de tracking ou des lots de 100 liens de tracking au maximum.
Authentification
Vous devez fournir une clé valide. Veuillez consulter notre page sur l’authentification et l’autorisation pour plus de détails : Comment puis-je générer ma clé d'accès à l'API éditeur ?
Générer une URL de tracking unique
Point de terminaison (POST)
https://api.awin.com/publishers/{publisherId}/linkbuilder/generate
Requête JSON Body
{
"advertiserId": 1111,
"destinationUrl": "https://www.awin.com",
"parameters": {
"campaign": "",
"clickref": "",
"clickref2": "",
"clickref3": "",
"clickref4": "",
"clickref5": "",
"clickref6": ""
}
}
| Nom du champ | Obligatoire? | Type | Description |
| advertiserId | Oui | Interger | ID de l’annonceur pour lequel vous créez le lien |
| destinationUrl | Non | String | La page spécifique pour laquelle vous créez le lien. Si elle n’est pas fournie, la page de destination par défaut de l’annonceur est utilisée. |
| Parameters | Non | Objet | Cela peut contenir n’importe lequel des paramètres de clic Awin. |
À quoi ressemble la réponse
En cas de succès, un code de réponse 200 est donné, ainsi qu'un JSON de la forme suivante :
{
“url”: “https://www.awin1.com/....”
}
Générer plusieurs URLs de tracking
Endpoint (POST)
https://api.awin.com/publishers/{publisherId}/linkbuilder/generate-batch
Un endpoint distinct permet de créer plusieurs liens de tracking avec un seul appel (jusqu’à un maximum de 100 dans le lot).
Le corps (body) est un objet JSON contenant un seul champ : requests. Il doit s’agir d’un tableau de requêtes dans le même format que la requête unique décrite ci-dessus.
Requête JSON Body
{
"requests": [
{
"advertiserId": 1111,
"destinationUrl": "https://www.awin.com",
"parameters": {
"clickref": "foo"
}
},
{
"advertiserId": 2222,
"destinationUrl": "https://www.example.com",
"parameters": {
"clickref": "foo"
}
}
]
}
À quoi ressemble la réponse
La réponse est un objet JSON contenant un seul champ « responses », qui est un tableau d’objets. Chacun de ces objets contient 2 champs : un statut (indiquant le code d’état HTTP qui aurait résulté de l’envoi singulier de la requête correspondante) et un corps. Le corps est comme expliqué pour la seule demande ci-dessus. En outre, il contient un champ de demande, qui inclut la charge utile de demande correspondante, pour faciliter le processus de corrélation des réponses avec les demandes d’origine.
{
"responses": [
{
"status": 200,
"body": {
"url": "https://www.awin1.com/...",
"request": {
"publisherId": 12345,
"advertiserId": 1111,
"destinationUrl": "https://www.awin.com/",
"parameters": {
"clickref": "foo"
}
}
}
},
{
"status": 200,
"body": {
"url": "https://www.awin1.com/...",
"request": {
"publisherId": 12345,
"advertiserId": 2222,
"destinationUrl": "https://www.example.com/",
"parameters": {
"clickref": "foo"
}
}
}
}
]
}
Il n'est actuellement pas possible de générer des liens courts via le endpoint de la génération par lots.
Récupération du quota de liens courts
Endpoint (GET)
https://api.awin.com/publishers/{publisherId}/linkbuilder/quota
Requête JSON Body
{
"shorten": {
"publisherId": 1234,
"limit": 100,
"usage": 0
}
}
| Nom du champ | Type | Description |
| publisherId | String | ID Awin éditeur |
| limit | String | Nombre maximum de liens courts que ce compte éditeur peut générer en 24 heures. |
| usage | Integer | Nombre de liens courts générés au cours des dernières 24 heures |
