Gestión de pixels

Consideraciones

• La aplicación debe estar registrada en https://developers.mercadolibre.com , obteniendo el application_id. (Se debe dar de alta la aplicación en Mshop).
• Para autorizar las peticiones, se utiliza Oauth (más info).
• Tener presente que un aplication_id, solo puede contar con un pixel_id. Para adquirir otro, debes dar de alta otra aplicación. a su Vez, un Pixel_id puede tener múltiples seller asociados
• Para realizar la asociación de un script a un seller, éste último debe haber delegado un dominio en MercadoShops. Si este paso no se realizó, la API devolverá un status code 401 con el siguiente mensaje: Your shop is not authorized for this request, you must have a delegated domain . Para identificar si el seller cuenta con dominio delegado o no (más info.)
• El formato de los scripts debe ser un template de Handlebars tal que se pueda obtener un código de JavaScript al reemplazar la variable de usuario. El código de JavaScript obtenido del script debe poder ser ejecutado dentro de una condición. Adicionalmente, es preferible que el script se mantenga lo más acotado posible, de tamaño total menor a 2kB, y si fuera necesaria lógica adicional, el script debe hacer un llamado para traer y ejecutar otro archivo de JavaScript almacenado en un CDN proporcionado por el Integrador.
• El nombre del archivo .Json no puede llevar espacios o caracteres especiales, Custom-script no los permite en los nombres de los Pixels.
• El script debe contener la variable que se define en el archivo .Json. Es factible llamar VARIABLE a la variable.

Ejemplo de scripts correcto:

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); 
} 

Este scripts se mostrará en la tienda de la siguiente manera:

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); 

Ejemplo de scripts incorrecto:

Glosario de campos y parámetros

Identificar el Dominio de la tienda

Llamada:

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

Respuesta:

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

Parámetros de la respuesta

Errores

Asociar script al Shop del vendedor

Llamada:

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

Ejemplo:

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

Respuesta:

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

Desactivar pixel

Con el el siguiente recurso podrás desactivar el pixel en todas las secciones en que se activó previamente al usuario (vendedor).

Llamada:

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

Ejemplo:

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

Respuesta:

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

Status Code