emailmanager

Home

emailmanager - API de Desarrollo (Versión 1.0)
Actualizada el: 08/07/2016 - 16:00hs

¡Bienvenido a la versión 1.0 Beta de la API de emailmanager!

A continuación, se explicará cómo funciona la comunicación con la API, cómo crear las llaves de la API (Api-Keys) y cómo ejecutar los métodos de la API presentes en este documento.

Las solicitudes a la API deben ser hechas desde la URL, pasando los parámetros de Api necesarios para identificar el cliente y usuario relacionados a la solicitud y los parámetros de métodos para ejecutar la funcionalidad deseada en el propio sistema.

Las solicitudes deben tener el siguiente formato, dependiendo de la versión utilizada y del método ejecutado:

http://api.emailmanager.com/1.0/?apikey=<apikey>&method=<método>& [outros Parámetros]

El método de autenticación, que es utilizado para obtener la clave de la API relacionada al usuario, debe ser ejecutada a partir de la llamada al método “authentLogin”, conforme el siguiente ejemplo:

http://api.emailmanager.com/1.0/?method=authentLogin&domain=<subdomínio>&username=<usuário>&password=<senha>

A continuación, vea algunos ejemplos de solicitudes que devolverán datos o valores para referencia (sustituya la palabra “suclavedeapi” por su clave de API, obtenida en los pasos anteriores):

http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=exceptions
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=editions&status_id=1
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=editionContent&cid=1
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=reportEditionStats&cid=1
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=reportUnsubscribes&group_id=1&cancel=true
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=editionMappedLinks&cid=1

Los tipos de “datos de salida” disponibles son: XML (formato SOAP), PHP (array serializado) e JSON (array misto), que pueden ser obtenidos fácilmente añadiendo el parámetro “output”, como en los siguientes ejemplos:

http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=exceptions&output=xml
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=exceptions&output=php
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=exceptions&output=json

Los “idiomas” disponibles para exhibición de los “Errores” son: pt_BR (portugués-brasileño), en_US (inglés-americano) y es_ES (español), pueden ser devueltos añadiendo el parámetro “language”:

http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=exceptions&language=pt_BR
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=exceptions&language=en_US
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=exceptions&language=es_ES

Por defecto, se devuelve un máximo de 100 registros por consulta. Para listar los datos deseados, en mayor cantidad, deber ser utilizados los parámetros “begin” y “limit”, informando la posición en que desea retornar el primer registro y la cantidad deseada. Vea el siguiente ejemplo que retorna 20 registros por consulta:

http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=contacts&begin=0&limit=20
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=contacts&begin=20&limit=20
http://api.emailmanager.com/1.0/?apikey=suachavedaapi&method=contacts&begin=40&limit=20


Métodos de "Errores"
Array exceptions ( string language )

Devuelve los códigos y mensajes de error que pueden ser generados por el sistema.

[+] Parámetros:

Métodos de "Autenticación"
String authentLogin ( string domain , string username , string password )

Realiza la autenticación de usuario en la base de datos del cliente y devuelve la clave de API del usuario, para acceder al resto de métodos.

[+] Parámetros:
Boolean authentLogout ( string apikey )

Realiza el logout del usuario en la base de datos del cliente y devuelve el resultado de la finalización del acceso.

[+] Parámetros:

Métodos de "Campañas"
Array campaigns ( int parent_id , string order , int begin , int limit )

Devuelve una lista con los grupos de campañas registrados en el sistema.

[+] Parámetros:
Int campaignCount ( int parent_id )

Devuelve el número total de grupos de campañas registradas en el sistema, filtrando por el grupo "padre", en caso de que se quiera.

[+] Parámetros:
Int campaignCreate ( int parent_id , string name )

Inserta un nuevo registro de grupo de campañas al grupo "padre" indicado.

[+] Parámetros:
Boolean campaignDelete ( int campaign_id )

Envía el grupo de campañas activo a la papelera, junto con todas las campañas que contiene.

[+] Parámetros:
Boolean campaignUpdate ( int campaign_id , string name , int parent_id )

Actualiza el registro de un grupo de campañas existente a partir de los datos pasados.

[+] Parámetros:

Métodos de "Grupos de Campañas"
Array editions ( datetime date_creation , datetime date_modified , datetime date_modified , int status_id , int campaign_id , int account_id , int folder_id , int mining_id , boolean content , string order , int begin , int limit )

Busca y lista las campañas de usuario de acuerdo a los parámetros pasados.

[+] Parámetros:
Int editionCount ( int campaign_id )

Devuelve el número total de campañas registradas en el sistema, filtrando por el "id" del grupo de campañas, si lo desea.

[+] Parámetros:
Array editionContent ( int cid )

Devuelve los datos de una determinada campaña, a partir de su identificación en el sistema.

[+] Parámetros:
Array editionMappedLinks ( int cid , boolean active , boolean analytics )

Devuelve los registros de links mapeados para la campaña en cuestión.

[+] Parámetros:
Int editionCreate ( string name , string description , string subject , string content_html , string content_txt , datetime date_send , int campaign_id , int account_id , int folder_id , int mining_id , array send_groups , array exclusion_groups )

Inserta un nuevo registro de campaña en el sistema, con estado "preparando".

[+] Parámetros:
Boolean editionDelete ( int cid )

Envía a la papelera el registro de la campaña con estado "preparando", evitando la liberación de la misma.

[+] Parámetros:
Boolean editionUpdate ( int cid , string name , string description , string subject , string content_html , string content_txt , datetime date_send , int campaign_id , int account_id , int folder_id , int mining_id , array send_groups , array exclusion_groups )

Modifica los datos del registro de una campaña con estado "preparando" en el sistema.

[+] Parámetros:
Array editionStatus ( boolean system )

Devuelve una lista con los tipos de "estado" a los cuales una campaña puede estar definida.

[+] Parámetros:
Array editionAccounts ( int account_id , datetime date_begin , datetime date_end , boolean validated , boolean mapping , boolean analytics , boolean auto_release , string order , int begin , int limit )

Consulta y lista las cuentas de envío de acuerdo a los parámetros pasados.

[+] Parámetros:
Int editionAccountCreate ( string name , string label , string email , string replyto , string abuse , boolean mapping , boolean analytics , boolean auto_release , string address , string city , string state , string country , string phone_country , string phone_code , string phone_number , string organization )

Inserta un nuevo registro de cuenta de envío con los datos pasados.

[+] Parámetros:
Boolean editionAccountDelete ( int account_id )

Envía a la papeleta el registro de la cuenta de envío "activa".

[+] Parámetros:
Boolean editionAccountUpdate ( int account_id , string name , string label , string email , string replyto , string abuse , boolean mapping , boolean analytics , boolean auto_release , string address , string city , string state , string country , string phone_country , string phone_code , string phone_number , string organization )

Actualiza un registro de cuenta de envío existe a partir de los datos pasados.

[+] Parámetros:
Array editionMinings ( datetime date_begin , datetime date_end , int folder_id , string order , int begin , int limit )

Consulta y lista los filtros de contactos, utilizados en el envío de campañas, de acuerdo con los parámetros pasados.

[+] Parámetros:
Array editionMiningFolders ( int parent_id , string order , int begin , int limit )

Consulta y lista las carpetas de filtros de contactos de acuerdo a los parámetros pasados.

[+] Parámetros:
Boolean editionPause ( int cid )

Define una campaña en progreso como "pausada", interrumpiendo el envío de la misma.

[+] Parámetros:
Boolean editionResume ( int cid )

Libera una campaña previamente "pausada", devolviendo el envío de la misma.

[+] Parámetros:
Boolean editionSendNow ( int cid )

Libera una campaña con estado "preparando", para que se efectue el envío de la misma en ese momento.

[+] Parámetros:
Boolean editionSchedule ( int cid , datetime date_send )

Libera una campaña con estado "preparando", para que se efectue el envío de la misma en la fecha y hora indicada.

[+] Parámetros:
Boolean editionUnschedule ( int cid )

Redefine el estado de una campaña "liberada" a "preparando", permitiendo la edición de la misma.

[+] Parámetros:

Métodos de "Contatos"
Array contacts ( datetime date_begin , datetime date_end , string email , string order , int begin , int limit )

Consulta y lista los Contactos de la base de datos de usuario de acuerdo a los parámetros pasados.

[+] Parámetros:
Array contactCount ( )

Devuelve el número total de contactos registrados en el sistema.

Array contactInfo ( int cid )

Devuelve los datos de un contacto registrado.

[+] Parámetros:
Array contactBatchInfo ( string cids )

Devuelve los datos de un o más contacto registrados.

[+] Parámetros:
Array contactStatus ( )

Devuelve una lista con las afiliaciones de contactos.

Array contactGroups ( int cid , string order , int begin , int limit )

Devuelve una lista con las afiliaciones de contactos.

[+] Parámetros:
Int contactCreate ( string name , string email , boolean gender , date date_birth , array groups_id , multi {extras} )

Inserta un nuevo registro de contacto en el sistema con los datos pasados, o devuelve el ID del contacto ya existente.

[+] Parámetros:
Boolean contactDelete ( int cid )

Envía a la papelera el registro del contacto "activo", evitando el envío de e-mails al mismo.

[+] Parámetros:
Boolean contactBatchDelete ( int group_id , string cids )

Elimina registros de contactos de un determinado grupo.

[+] Parámetros:
Boolean contactUpdate ( int cid , string name , string email , boolean gender , date date_birth , array groups_id , multi {extras} )

Actualiza los datos de un registro de contacto en el sistema con los datos pasados.

[+] Parámetros:
Boolean contactSubscribe ( int cid , array groups_id )

Registra las afiliaciones del contacto de acuerdo a los grupos de contacto indicados.

[+] Parámetros:
Boolean contactUnsubscribe ( int cid , array groups_id )

Elimina las afiliaciones del contacto de acuerdo a los grupos de contacto indicados.

[+] Parámetros:
Boolean contactCancel ( int cid )

Marca el contacto como "Solicitó desuscripción" para que no se le envíen campañas.

[+] Parámetros:
Array contactBatchSubscribe ( int group_id , array emails )

Registra y/o afilia los emails de los contactos al grupo indicado y devuelve una lista con los IDs de los e-mails que fueron afiliados.

[+] Parámetros:
Array contactBatchCreate ( int group_id , array metadata , boolean check , boolean update, boolean info )

Registra y/o afilia los datos de los contactos en el grupo ingresado y retorna una lista con los IDs de los contactos registrados y/o afilidados.

[+] Parámetros:

Métodos de "Grupos"
Array groups ( int folder_id , int parent_id , string order , int begin , int limit )

Devuelve una lista con los grupos de contactos registrados en el sistema.

[+] Parámetros:
Array groupCount ( int parent_id , int folder_id )

Devuelve el número total de grupos de contactos registrados en el sistema, filtrando por el grupo "padre", si lo desea.

[+] Parámetros:
Array groupContacts ( int group_id , string order , int begin , int limit )

Devuelve una lista con los contactos afiliados de un grupo de contactos referido.

[+] Parámetros:
Int groupCreate ( int folder_id , int parent_id , string name , string description )

Inserta un nuevo registro de grupo de contactos en la carpeta "padre" indicada.

[+] Parámetros:
Boolean groupDelete ( int group_id )

Envía a la papelera el registro del grupo "activo", junto con todos los contactos que contiene.

[+] Parámetros:
Boolean groupUpdate ( int group_id , string name , string description , int parent_id , int folder_id )

Actualiza un registro de grupo de contactos existente, a partir de los datos pasados.

[+] Parámetros:
Array groupFolders ( int parent_id , string order , int begin , int limit )

Devuelve una lista de todas las carpetas de grupos de contactos registradas en el sistema.

[+] Parámetros:
Array groupFolderCount ( int parent_id )

Devuelve el número total de carpetas de grupos de contatos registrados en el sistema, filtrando la carpeta "padre", en el caso deseado.

[+] Parámetros:
Int groupFolderCreate ( int parent_id , string name )

Inserta una nueva carpeta de grupos de contactos en la carpeta "padre" deseada.

[+] Parámetros:
Boolean groupFolderDelete ( int folder_id )

Borra la carpeta de grupo de contactos.

[+] Parámetros:
Boolean groupFolderUpdate ( string name , int parent_id , int folder_id )

Actualiza un registro de la carpeta de grupos de contactos existentes a partir los datos pasados.

[+] Parámetros:

Métodos de "Reportes de las Campañas"
Array reportEditionStats ( int cid )

Devuelve un reporte de datos respecto a la campaña indicada.

[+] Parámetros:
Array reportEditionGeoCountry ( int cid , boolean unique )

Devuelve una lista de datos relacionados a la cantidad de accesos efectuados en una campaña por país.

[+] Parámetros:
Array reportEditionGeoRegion ( int cid , string country , boolean unique )

Devuelve una lista de datos relacionados a la cantidad de accesos efectuados en una campaña por estado o provincia, dentro del país indicado.

[+] Parámetros:
Array reportEditionSents ( int cid , datetime date_begin , datetime date_end , string order , int begin , int limit )

Devuelve la lista de registros a los que se ha enviado la campaña.

[+] Parámetros:
Array reportEditionViews ( int cid , datetime date_begin , datetime date_end , boolean unique , string order , int begin , int limit )

Devuelve la lista de registros de visualizaciones, de los emails de la campaña.

[+] Parámetros:
Array reportEditionClicks ( int cid , datetime date_begin , datetime date_end , int link_id , boolean unique , string order , int begin , int limit )

Devuelve la lista de clics registrados junto a los links de la campaña.

[+] Parámetros:
Array reportEditionSoftBounces ( int cid , datetime date_begin , datetime date_end , string order , int begin , int limit )

Devuelve la lista de errores temporales, registrados junto con la campaña correspondiente.

[+] Parámetros:
Array reportEditionHardBounces ( int cid , datetime date_begin , datetime date_end , string order , int begin , int limit )

Devuelve la lista de errores permanentes, registrados junto con la campaña correspondiente.

[+] Parámetros:
Array reportEditionUnsubscribes ( int cid , datetime date_begin , datetime date_end , int contact_id , boolean cancel , string order , int begin , int limit )

Devuelve la lista de denuncios hechas por los contactos, junto a la campaña correspondiente.

[+] Parámetros:
Array reportEditionAbuses ( int cid , datetime date_begin , datetime date_end , string order , int begin , int limit )

Devuelve la lista de los abusos denunciados por los contactos con la cuestión.

[+] Parámetros:

Métodos de "Reportes de los Contactos"
Array reportContactSents ( int cid , datetime date_begin , datetime date_end , string order , int begin , int limit )

Devuelve la lista de registros de envíos de emails, para el contacto correspondiente.

[+] Parámetros:
Array reportContactViews ( int cid , datetime date_begin , datetime date_end , int marketing_id , string order , int begin , int limit )

Devuelve la lista de registros sobre las visualizaciones de los e-mails de un contacto.

[+] Parámetros:
Array reportContactClicks ( int cid , datetime date_begin , datetime date_end , int marketing_id , int link_id , string order , int begin , int limit )

Devuelve la lista de clics registrados por el contacto, junto a los links de la campaña.

[+] Parámetros:
Array reportContactSoftBounces ( int cid , datetime date_begin , datetime date_end , string order , int begin , int limit )

Devuelve la lista de errores temporales, registrados para el contacto.

[+] Parámetros:
Array reportContactHardBounces ( int cid , datetime date_begin , datetime date_end , string order , int begin , int limit )

Devuelve la lista de errores permanentes, registrados para el contactos.

[+] Parámetros:

Métodos de "Reportes de los Grupos"
Array reportGroupStats ( int group_id )

Devuelve un reporte de datos referentes al grupo de contactos indicado.

[+] Parámetros:

Métodos de "Reportes Generales"
Array reportStats ( date date_begin , date date_end , int marketing_id , int begin , int limit )

Devuelve un reporte general de envío e interacciones de todas las campañas, agrupado por la fecha de interacción.

[+] Parámetros:
Array reportSents ( datetime date_begin , datetime date_end , int marketing_id , int contact_id , string order , int begin , int limit )

Devuelve la lista de registros de envío de e-mails de las campañas del sistema.

[+] Parámetros:
Array reportViews ( datetime date_begin , datetime date_end , int marketing_id , int contact_id , boolean unique , string order , int begin , int limit )

Devuelve la lista de contactos que visualizaron las campañas enviadas por el sistema.

[+] Parámetros:
Array reportClicks ( datetime date_begin , datetime date_end , int marketing_id , int link_id , int contact_id , boolean unique , string order , int begin , int limit )

Devuelve la lista de clics registrados, junto a las campañas del sistema.

[+] Parámetros:
Array reportBounces ( datetime date_begin , datetime date_end , int marketing_id , int contact_id , boolean temporary , string order , int begin , int limit )

Devuelve la lista de errores de recepción registrados en los envíos de las campañas.

[+] Parámetros:
Array reportUnsubscribes ( datetime date_begin , datetime date_end , int marketing_id , int contact_id , boolean cancel , string order , int begin , int limit )

Devuelve la lista de contactos que se dieron de baja de las campañas del sistema.

[+] Parámetros:
Array reportAbuses ( int cid , datetime date_begin , datetime date_end , int marketing_id , string order , int begin , int limit )

Devuelve la lista de abusos relatados por los contactos en las campañas del sistema.

[+] Parámetros:
Array reportBlacklist ( date date_begin , date date_end , string order , int begin , int limit )

Devuelve un informe de datos con los correos electrónicos que estan en lista negra.

[+] Parámetros:
Array reportNotifyMessages ( boolean displayed , date date_begin , date date_end , string order , int begin , int limit )

Devuelve una lista de los mensajes de notificación registrados en la base de datos del cliente.

[+] Parámetros:
Array reportNotifyCount ( boolean displayed )

Devuelve el número total de mensajes de notificación registrados en la base de datos del cliente, mostradas o no.

[+] Parámetros:
Métodos de "Usuarios"
Array users ( string order , int begin , int limit )

Devuelve una lista de los usuarios registrados en el sistema.

[+] Parámetros:
Int userCreate ( string name , string email , int permission_id , array departaments_id , string password , boolean active )

Registra un nuevo usuario en el sistema con los datos pasados, o devuelve el ID del usuario ya existente.

[+] Parámetros:
Int userUpdate ( int uid , string name , int permission_id , array departaments_id , boolean active )

Actualiza el registro del usuario existente en el sistema con los datos pasados.

[+] Parámetros:
Boolean userDelete ( int uid )

Elimina un usuario existente en el sistema, eliminando también el acceso.

[+] Parámetros:
Array userPermissions ( string order , int begin , int limit )

Devuelve una lista de los grupos de permisos relacionados a los usuarios.

[+] Parámetros:
Array userDepartaments ( string order , int begin , int limit )

Devuelve una lista de departamentos a los cuales los usuarios pueden estar asociados.

[+] Parâmetros: