Conteúdo
POST gerador de link rastreado
Autenticação
Gerando uma única URL de rastreamento
Gerando multiplas URLs de rastreamento
Recurepando link encurtado
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
POST gerador de link rastreado
Os afiliado podem publicar uma URL de destino para um anunciante gerar um link de rastreamento Awin. Esse endpoint permite que você gere um único link de rastreamento ou lotes de até 100 links de rastreamento.
Autenticação
Você precisa fornecer um token válido. Consulte nossa página sobre autenticação e autorização para obter mais detalhes. Como posso gerar meu token de acesso API do Publisher?
Gerando uma única URL de rastreamento
Endpoint (POST)
https://api.awin.com/publishers/{publisherId}/linkbuilder/generate
JSON request Body
{
"advertiserId": 1111,
"destinationUrl": "https://www.awin.com"",
"parameters": {
"campaign": "",
"clickref": "",
"clickref2": "",
"clickref3": "",
"clickref4": "",
"clickref5": "",
"clickref6": ""
}
}
| Nome do campo | Obrigatório? | Tipo | Descrição |
| advertiserId | Sim | Interger | ID do anunciante para quem você está criando o link |
| destinationUrl | Não | String | A página específica que você deseja vincular. Se não for fornecido, é utilizada a página de destino padrão do anunciante. |
| parameters | Não | Object | Isto pode conter qualquer um dos parâmetros de clique Awin. |
Como é a resposta
Se bem-sucedido, é dado um código de resposta de 200, juntamente com o JSON da seguinte forma:
{
“url”: “https://www.awin1.com/....”
}
Gerando múltiplas URLs de rastreamento
Endpoint (POST)
https://api.awin.com/publishers/{publisherId}/linkbuilder/generate-batch
Um endpoint separado permite a criação de múltiplos links de rastreamento com uma única chamada (até um máximo de 100 no lote).
O corpo é um objeto JSON que contém um único campo: os pedidos. Este deve ser um conjunto de solicitações no mesmo formato que a solicitação única descrita acima.
JSON request Body
{
"requests": [
{
"advertiserId": 1111,
"destinationUrl": "https://www.awin.com"",
"parameters": {
"clickref": "foo"
}
},
{
"advertiserId": 2222,
"destinationUrl": "https://www.example.com"",
"parameters": {
"clickref": "foo"
}
}
]
}
Como é a resposta
A resposta é um objeto JSON contendo um único campo "respostas", que é um conjunto de objetos. Cada um desses objetos contém 2 campos: um status (indicando o código de status HTTP que teria resultado do envio singular da solicitação correspondente), e um corpo. O corpo é como explicado para o pedido único acima. Além disso, isto contém um campo de solicitação, que inclui a carga útil de solicitação correspondente, para ajudar no processo de correlacionar as respostas com as solicitações originais.
{
"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"
}
}
}
}
]
}
No momento, não é possível gerar links curtos por meio do endpoint de geração de lote.
Recuperando link encurtado
Endpoint (GET)
https://api.awin.com/publishers/{publisherId}/linkbuilder/quota
JSON request Body
{
"shorten": {
"publisherId": 1234,
"limit": 100,
"usage": 0
}
}
| Nome do campo | Tipo | Descrição |
| publisherId | String | Awin publisher ID |
| limit | String | Número máximo de links encurtados que a conta do afiliado pode gerar em 24 horas. |
| usage | Integer | Número de links encurtados gerados nas últimas 24 horas. |
