Documentación

ADMINISTRACIÓN DEL SITIO

En esta sección encontrarás la descripción de los servicios que te permiten obtener información de un sitio de MercadoShops y administrar su estructura.

Tambien encontraras la información necesaria para utilizar la API de métricas.

Indice

Info del sitio Metricas Listar tracking_codes por usuario Obtener un tracking_code por id Crear un tracking_code Modificar un tracking_code Eliminar un tracking_code

Info del sitio

GET  /v1/shops/{SHOP_ID}?access_token={ACCESS_TOKEN} 
Obtener la información de un sitio en MercadoShops

Mostrar ejemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}?access_token={token} 

Parametros

ParametroValoresEjemplo
access_token Codigo de seguridad Access_token=APP_USR-4X30-XXXXX-275bbb6c084d53b8f9fc691770fda9b2__C_I__-15XXXX24
SHOP_ID Id de usuario https://api.mercadoshops.com/v1/shops /15XXXXX24?acess_token=**************
id
ID de usuario
Tipo
NUMERICO
status
Estado del sitio
Tipo
STRING
Valores
active
Activo
close
Cerrado
locale
Idioma _ Codigo Pais
Tipo
STRING
Para obtener el listado de codigos de paises habilitados utiliza este recurso:
https://api.mercadolibre.com/XXXX
shop_name
Nombre del Sitio
Tipo
STRING
email
Email de contacto del sitio
Tipo
STRING
plan
Tipo del plan contratado en mercadoshops
Tipo
STRING
admin_url
URL de administración del Sitio
Tipo
STRING
url
URL del Sitio
Tipo
STRING
has_logo
Tiene logo
Tipo
BOOLEAN (true / false)
address
{
Descripcion
Direccion
Tipo
Objeto
country
Codigo del Pais
Tipo
STRING
Para obtener el listado de codigos de paises habilitados utiliza este recurso:
https://api.mercadolibre.com/countries/
state
Codigo del estado/provicia del Pais
Tipo
STRING
Para obtener el listado de codigos de estados/provincias de cada pais utiliza este recurso:
https://api.mercadolibre.com/countries/{CODIGO_PAIS}
zip
Codigo Postal
Tipo
STRING
address
Domicilio
Tipo
STRING
phone
Teléfono
Tipo
STRING
}
{
id
199999924,
status
active,
locale
es_AR,
shop_name
"mercadoshops_demo",
email
"demo_demo@mercadoshops.com",
plan
"professional_plus",
admin_url
"http://admin.mercadoshops_demo.com.ar",
url
" http://mercadoshops_demo.com.ar ",
has_logo
true,
address
{
country
"AR",
state
"AR-B",
city
"Olivos",
zip
null,
address
"MI callle 1000 Dto 1",
phone
"+54911000099999"
}
}
ERRORES :
403: Token Invalido o SHOP_ID incorrecto

Metricas

API de métricas y códigos de seguimiento

Indice de acciones en Metricas:

Listar tracking_codes por usuario Obtener un tracking_code por id Crear un tracking_code Modificar un tracking_code Eliminar un tracking_code

Acciones

LISTAR TRACKING_CODES POR USUARIO

Retorna una lista de todos los tracking_code activos asociados al usuario, opcionalmente filtrada por event y/o provider.

GET  /shops/{SHOP_ID}/metrics?event=$event&provider=$provider 

Mostrar ejemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/ metrics?event={event}&provider={provider}&access_token={token} 

Parametros

ParametroValoresEjemplo
access_token Codigo de seguridad Access_token=APP_USR-4X30-XXXXX-275bbb6c084d53b8f9fc691770fda9b2__C_I__-15XXXX24
SHOP_ID Id de usuario de mercadolibre / mercadoshops https://api.mercadoshops.com/v1/shops/{SHOP_ID}/ metrics?acess_token=**************
Event (opcional) NAVIGATION
BUY_BUTTON
CONTACT_BUTTON
PAY_BUTTON
CONGRAT_PAGE
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/ metrics?event=NAVIGATION&acess_token=**************
Provider (opcional) G_ANALYTICS
G_ADWORDS
M_CLICS
EBIT_SURVEY
EBIT_STAMP
FB_AD
OTHER
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/ metrics?provider=FB_AD&acess_token=**************
HTTP STATUS 200 OK
{
id
Id de código de seguimiento
Tipo
NUMERICO
shop_id
ID de usuario
Tipo
NUMERICO
name
nombre que describe el código de seguimiento
Tipo
STRING
code
el snippet HTML que se incluirá en el sitio web
Tipo
STRING
options
JSON - un mapa de opciones, específico al 'provider'
Tipo
STRING (JSON)
provider
Tipo de proveedor
Tipo
STRING
Valores posibles
G_ANALYTICS
G_ADWORDS
M_CLICS
EBIT_SURVEY
EBIT_STAMP
FB_AD
OTHER
event
Tipo de evento
Tipo
STRING
Valores posibles
NAVIGATION
BUY_BUTTON
CONTACT_BUTTON
PAY_BUTTON
CONGRAT_PAGE
status
estado
Tipo
STRING
Valores posibles
ACTIVE
INACTIVE
}
{
id
3***51,
shop_id
15****4,
name
Test API2,
code
"",
options
"",
provider
"OTHER",
event
"NAVIGATION",
status
"ACTIVE"
}
ERRORES :
401 Unauthorized: Unauthorized {"error": "You are unauthorized to make this request"}
400 Unauthorized: Bad Request {"error": "Invalid filter parameter"}
OBTENER UN TRACKING_CODE POR ID

Retorna el tracking_code identificado por id.

GET  /shops/{shop_id}/metrics/{id} 

Mostrar ejemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/metrics?{id}&access_token={token} 

Parametros

ParametroValoresEjemplo
access_token Codigo de seguridad Access_token=APP_USR-4X30-XXXXX-275bbb6c084d53b8f9fc691770fda9b2__C_I__-15XXXX24
SHOP_ID Id de usuario de mercadolibre / mercadoshops https://api.mercadoshops.com/v1/shops /15XXXXX24/
ID Id de tracking https://api.mercadoshops.com/v1/shops /15XXXXX24/metrics/11111111?acess_token=**************
Retorna el tracking_code identificado por id.
HTTP STATUS 200 OK
{
id
3***9,
shop_id
15*****4,
name
"Test API",
code
"<!-- Begin test Embed Code --><!-- End testEmbed Code -->",
options
{
},
provider
"OTHER",
event
"NAVIGATION",
status
"ACTIVE"
}
ERRORES :
401 Unauthorized: Unauthorized {"error": "You are unauthorized to make this request"}
400 Unauthorized: Bad Request {"error": "Invalid filter parameter"}
CREAR UN TRACKING_CODE

Crea un tracking_code y devuelve el objeto creado.

POST  HEADER: Content-Type: application/json
     /shops/{shop_id}/metrics 

Mostrar ejemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/metrics?{id}&access_token={token}
Retorna el tracking_code identificado por id.
HTTP STATUS 201 CREATED
{
id
3***9,
shop_id
1******24,
name
"Test API",
code
"<!-- Begin test Embed Code --><!-- End testEmbed Code -->",
options
{
},
provider
"OTHER",
event
"NAVIGATION",
status
"ACTIVE"
}
ERRORES :
401 Unauthorized: Unauthorized {"error": "You are unauthorized to make this request"}
400 Unauthorized: Bad Request {"error": "Invalid filter parameter"}
MODIFICAR UN TRACKING_CODE

Modifica un tracking_code y devuelve el objeto modificado.

PUT  HEADER :  Content-Type: application/json                      
     /shops/{shop_id}/metrics/{id} 

Mostrar ejemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/metrics?{id}&access_token={token}

Para modificar un atributo del tracking creado hay que hacer un PUT a la url indicada con un JSON que incluya el atributo y su nuevo valor.
Ejemplo de JSON de cambio de del atributo [name]:
{name: "Test API2 - CHANGED"}

Retorna el tracking_code modificado por id.
HTTP STATUS 200 OK
{
name
"Test API2 - CHANGED",
}
ERRORES :
401 Unauthorized: Unauthorized {"error": "You are unauthorized to make this request"}
400 Unauthorized: Bad Request {"error": "Invalid filter parameter"}
404 Not found: {"error": "Tracking code not found"} 
ELIMINAR UN TRACKING_CODE

Elimina un tracking_code.

DELETE  /shops/{shop_id}/metrics/{id} 

Mostrar ejemplo 
https://api.mercadoshops.com/v1/shops/{SHOP_ID}/metrics?{id}&access_token={token}
HTTP STATUS 204 NO CONTENT
ERRORES :
401 Unauthorized: Unauthorized {"error": "You are unauthorized to make this request"}
400 Unauthorized: Bad Request {"error": "Invalid filter parameter"}