Gerenciar pixels

Considerações

• A aplicação deve ser registada em https://developers.mercadolibre.com , obtendo o application_id. (O aplicativo deve ser registrado no Mshop).
• Para autorizar requisições, utiliza-se o Oauth (mais info).
• Lembre-se de que um application_id só pode ter um pixel_id. Para adquirir outro, você deve registrar outro aplicativo. Por sua vez, um Pixel_id pode ter vários vendedores associados a ele.
• Para associar um script a um vendedor, este deve ter delegado um domínio ao MercadoShops. Caso esta etapa não tenha sido realizada, a API retornará um código de status 401 com a seguinte mensagem: Your shop is not authorized for this request, you must have a delegated domain . Para identificar se o vendedor tem domínio delegado ou não (mais info.)
• O formato dos scripts deve ser um modelo Handlebars de forma que um código JavaScript possa ser obtido substituindo a variável de usuário. O código JavaScript obtido do script deve poder ser executado dentro de uma condição. Além disso, é preferível que o script seja mantido o menor possível, com um tamanho total menor que 2kB, e se for necessária lógica adicional, o script deve fazer uma chamada para buscar e executar outro arquivo JavaScript armazenado em um CDN fornecido pelo Integrador.
• O nome do arquivo .Json não pode conter espaços ou caracteres especiais, o Custom-script não os permite nos nomes dos Pixels.
• O script deve conter a variável definida no arquivo .Json. É viável chamar a variável de VARIABLE.

Exemplo de scripts correto:

script.hbs

if (/*condition*/) { 
var 
src="https://test-pixel.com/api/script/mercadoshops/onLoad.js?=shop123"; var script = document.createElement("script"); 
script.setAttribute("src", src); 
document.getElementsByTagName("head")[0].appendChild(script); 
} 

Esse scripts será exibido na loja da seguinte maneira:

var src="https://test-pixel.com/api/script/mercadoshops/onLoad.js?={{VARIABLE}}"; var script = document.createElement("script"); 
script.setAttribute("src", src); 
document.getElementsByTagName("head")[0].appendChild(script); 

Exemplo de scripts incorreto:

Glossário de campos e parâmetros

Identifique o domínio da loja

Chamada:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/shops/public-domains

Resposta:

{
    "domain": "www.shop.domain.com",
    "shop_id": 123242154125,
    "status": "ACTIVE",
    "delegation_type": "PARTIAL",
    "site": "MCO"
}

Parámetros de respuesta

Erros

Associar script ao Shop do vendedor

Chamada:

curl -X POST-H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -d
    {...}
https://api.mercadolibre.com/shops/custom-scripts/ext/integration

Exemplo:

curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -d
'{
  "pixel_id": "XXXXX",
  "sections": ["home", "search", "vip", "cart", "contact"],
  "external_client_id": "XXXXX",
}
'
https://api.mercadolibre.com/shops/custom-scripts/ext/integration

Resposta:

{
  "id": "XXXXX",
  "pixel": {
    "id": "XXXXX",
    "description": "XXXXX"
  },
  "created_at": "XXXXX",
  "sections": ["home", "search", "vip", "cart", "contact"]
}

Desativar pixel

Com o seguinte recurso você pode desativar o pixel em todas as seções em que o vendedor foi ativado anteriormente.

Chamada:

curl -X DELETE -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/shops/custom-scripts/ext/integration?integration_id={INTEGRATION_ID}

Exemplo:

curl -X DELETE -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/shops/custom-scripts/ext/integration?integration_id={INTEGRATION_ID}

Resposta:

{
  "updated_at": "XX/XX/XX",
  "status": "Disabled",
  "external_client_id": "XXXXX"
}

Status Code