Conociendo nuestra API

Sobre nuestra API de integración

La API (Application Program Interface) te permitirá integrar el email marketing con cualquier otro sistema externo. Esta es una API RESTfull. Todas las llamadas a la API deben ser hechas con HTTP POST y HTTP GET. En respuesta a las llamadas, la API devolverá su respuesta en formato JSON.

 

RESTful API

Esta es una API RESTfull. Todas las llamadas a la API deben ser hechas con HTTP POST y HTTP GET. En respuesta a las llamadas, la API devolverá su respuesta en formato JSON.
También es posible hacer el request enviando el body en formato JSON.

 

URL de la API

Todas las llamadas a la API se harán a la misma URL correspondiente a su cuenta. Puede consultar esta URL en “Información de cuenta” solapa “API”.

 

Aclaraciones previas

Dado que la URL de la API dependerá de la que corresponda a su cuenta, para todos los ejemplos en esta documentación utilizaremos el dominio “{SERVERURL}”. Te en cuenta que esta URL no existe, si no que es solo a modo ejemplo.

 

Estructura de la documentación

La documentación de la API esta dividida en funciones o acciones. Cada acción esta resaltada en color verde. En cada apartado de acción, podrá encontrar una descripción o consideraciones a tener en cuenta para esa acción, seguido de una tabla de parámetros de entrada, seguido de una tabla con información sobre los valores de retorno, seguido una tabla con los posible errores y seguido de información necesaria para entender más el uso de la acción. Algunos parámetros podrían necesitar de una ayuda adicional, en ese caso será dada al final del apartado.

 

Llamada a las funciones

Las funciones se determinan en la URL. Por ejemplo para crear una campaña llamaremos a la URL
http://{SERVERURL}/api/2.0/message/create

Si quisiéramos obtener las estadísticas del envío de una campaña llamaríamos a la URL
http://{SERVERURL}/api/2.0/message/stats

La URL de consulta es del tipo
http://{SERVERURL}/api/2.0/MODULO/ACCION

 

Autenticación

Todas las funciones de la API requieren uno o varios parámetros de identificación de su cuenta. Algunas funciones podrán requerir de su nombre de usuario y contraseña, que serán los mismo que utiliza para el acceso a la plataforma. Otras funciones requerirán una clave llamada “user_key” la cual puede encontrar en la sección “Herramientas -> API e integración”.

Parámetros
login_username
string
Nombre de usuario de acceso a la cuenta.
login_password
string
Contraseña de la cuenta.
listid
string
Es el identificador de la lista. (Esta variable solo es requerida en el modulo de suscripción). **
user_key
string
Cadena alfanumérica que identifica una cuenta de usuario. (Esta variable solo es requerida en el módulo de emails transaccionales).

(**) Puede encontrar el identificador de cada lista en la sección “Herramientas -> API e integración” o en la configuración de la lista.

 

Manejo de errores

Siempre que se produzca un error, la API devolverá un “status” igual a “error”, un código de error y una descripción del mismo.

Por ejemplo:
{
"status":"error",
"errno":"103001A",
"message":"Recipient address is missing or not valid."
}

Valores de respuesta
status “error”
error Código de error, numérico o alfanumérico.
message Descripción de error

 

Errores de API

Esta es una lista de los errores comunes en la API para cualquier modulo.

Codigos de error
001001A No se ha proporcionado una user_key o la misma es inválida.
001002A La cuenta de usuario se encuentra suspendida.
001003E El módulo no existe. Verifique la URL de consulta.
001004E La acción no existe. Verifique la URL de consulta.

 

Ejemplos de request

Request JSON

URL: http://{SERVERURL}/api/2.0/list/get

Body:
{
"user_key":"261615af2e48a86459ead77",
"list_id":"103001019AZD",
}