Introducción a la API de arrobaMail

Una API (Application Programming Interface) representa un conjunto de definiciones y métodos que utilizan los software's para comunicarse entre sí. Pequeños, medianos y sobretodo grandes negocios cuentan con su propia API para permitir que otros sistemas se comuniquen con los suyos. arrobaMail cuenta con su propia API, con el objetivo de que sus usuarios puedan implementar en sus desarrollos y sistemas el servicio de eMail Marketing de una forma simple y rápida.

Sobre nuestra API e integración.

La API de arrobaMail 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

RESTfull 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 la petición (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 dirigiendose a la sección Herramientas a través del botón ubicado en la parte superior. Luego, buscar y seleccionar la opción de API e Integración.

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}”. Ten en cuenta que esta URL no existe, si no que es solo a modo ejemplo.

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

En definitiva, la URL para peticionar a la API es:

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.

Puedes consultar la USER_KEY dirigiendote a la sección Herramientas a través del botón ubicado en la parte superior. Luego, buscar y seleccionar la opción de API e Integración.

En la siguiente tabla puede apreciar los parámetros utilizados para la autenticación a través de la API.

Manejo de errores

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

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

Valores de respuesta

Errores de la API

Esta es una lista de los errores comunes en la API para cualquier módulo.

Ejemplos de peticiones (request)

A continuación, le presentamos el ejemplo de una petición realizada a la API de arrobaMail, enviando en el cuerpo de la petición los parámetros user_key y list_id. El primero, como se menciona en párrafos anteriores, identifica al usuario, y el segundo a la lista de suscriptores en la plataforma de arrobaMail.

URL

http://{serverurl}/api/2.0/list/get

Cuerpo (Body) de la petición

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

Esperamos que este artículo sea de utilidad a la hora de dar tus primeros pasos con nuestra API. Para más información, te sugerimos revisar nuestra Referencia de API dónde encontrarás todos los módulos disponibles con sus respectivas operaciones.