Integraciones

bbaner-Integraciones Sigma Móvil

Sigma Movil identifica una gran oportunidad en integrar las plataformas tecnológicas, con el objetivo de agregar la funcionalidad de envíos de mensaje de texto y correo electrónico al Software que actualmente poseen y comercializan con sus clientes.

A continuación, describiremos el uso del API REST de la plataforma de EMAIL MARKETING de SIGMA MÓVIL.

Este API sigue los principios REST, en particular:

  • Stateless: no se mantiene estado entre llamadas en el servidor. No se hace uso de cookies ni se mantienen sesiones. Esto implica que cada solicitud debe incluir información de autenticación.
  • Uso de los verbos de HTTP para indicar las acciones (GET, PUT, DELETE, POST).
  • URLs consistentes para identificar los objetos.
  • Funcionamiento de métodos (GET no modifica la información, DELETE y PUT siempre generan los mismos resultados).

El formato de la información es JSON.

La autenticación hace uso del encabezado de HTTP con un mecanismo propietario similar al utilizado por Amazon S3 y otros proveedores. Su implementación se puede lograr con funciones disponibles en muchos lenguajes de programación modernos.

Autenticación

La seguridad es imprescindible para Sigma Móvil y por eso elegimos un mecanismo de autenticación que tiene características que lo hacen muy fuerte y al mismo tiempo fácil de implementar.

Cada solicitud (request HTTP) debe ser autenticada de manera individual, enviando una cadena que consta de dos partes: un API KEY que sirve para identificar al usuario del sistema; y una firma digital, que se calcula a partir del contenido de la transacción y una clave secreta asociada al usuario.

Esta cadena de autenticación se envía en un header (Encabezado) HTTP.

El API KEY y la clave secreta se obtienen desde la plataforma. La firma digital se calcula utilizando la clave secreta, el cuerpo de la solicitud (request body), el método de request (ej: GET, POST, PUT) y la URL del request.

El API KEY y el SECRET se encuentran en la sección de administración de usuarios de la cuenta.

Al lado derecho de cada usuario hay un botón que permite la creación del API KEY de ese usuario. Al oprimir el botón, el sistema genera de forma aleatoria los dos códigos.

api-Integraciones Sigma Móvil

Si se desea evitar que una aplicación que podía utilizar el API anteriormente lo siga utilizando, puede desactivar el key que utiliza haciendo clic en el botón que se indica en la imagen. Si cree que la información de autenticación ha sido comprometida, puede generar nuevamente los dos códigos, lo que elimina los anteriores y crea nuevos para utilizar en sus aplicaciones. Las aplicaciones que estuvieran utilizando ese par de códigos dejarán de funcionar.

Cada transacción debe ser autenticada. Para ello, se debe tomar el texto de la URL del request HTTP, el método HTTP que se utiliza y el contenido (cuerpo) de la solicitud, si está presente. Toda esta información es concatenada usando el carácter “|” (pipe) como separador de cada parte y luego se utiliza el algoritmo HMAC con el código de SECRET y el hash SHA-1 para calcular la firma digital. El algoritmo HMAC se explica en detalle a continuación:

Al hacer el request HTTP se incluye un encabezado de autenticación así

Authorization: Hmac cadena_de_autenticacion

La “cadena_de_autenticación” se crea de la siguiente manera:

BASE64( API_KEY:SIGNATURE ) Donde,

‣ BASE64: es la función de codificación de texto

‣ API_KEY: es la clave API key que se obtiene en la plataforma como se mostró anteriormente

‣ SIGNATURE: es la firma digital de la transacción, calculada con el algoritmo

HMAC usando SHA-1

Para ilustrar mejor el mecanismo este ejemplo puede ayudar:

Si se va a ejecutar un request a la URL “https://aio.sigmamovil.com/api/v1/echo” que es un servicio del API utilizado para realizar pruebas, el método es GET y no se envían datos en el cuerpo del mensaje. Si el API KEY es “123” y el SECRET es “abcd”, entonces el header se calculará así:

Este es el header que se incorporaría al request.

URL = “https://aio.sigmamovil.com/api/v1/echo” metodo =“GET” key = “123” secret = “abcd”

msg = URL + “|” + metodo + “|” signature =

HMAC(“sha-1”, msg, secret)

header = “Authorization: Hmac “ + BASE64( key + “:” + signature)

Código de prueba

En esta documentación se incluyen ejemplos en PHP que hacen uso de la siguiente clase para ejecutar las transacciones. Se utiliza en este ejemplo por conveniencia ya que este código calcula la cadena de autenticación de cada mensaje enviado y ejecuta el request.

api-Integraciones Sigma Móvil

Ejemplo:
Integraciones Sigma Móvil

Respuesta:
Integraciones Sigma Móvil

Ver listas de contactos de la subcuenta

Este servicio retorna todas las listas de contactos que tiene la subcuenta. También retorna información como el total de registros y el número de páginas, los datos estarán limitados en 15 registros por página.

  • URL: https://aio.sigmamovil.com/api/contactlist/getcontactlists/{pagina}/{nombre}
  • Método: GET
  • Parámetro:

o página: Numero de la página

o nombre: Escribir el nombre de alguna lista para filtrar por este.

  • Datos: No se envían datos.

Integraciones Sigma Móvil

Integraciones Sigma Móvil

Crear listas de contactos

Este servicio crea una nueva lista de contactos en la subcuenta.

  • URL: https://aio.sigmamovil.com/api/contactlist/add
  • Método: POST

• Datos: Objeto JSON con información de la nueva lista de contactos

Integraciones Sigma Móvil-contacto

Integraciones Sigma Móvil-contacto

Editar lista de contacto

Este servicio edita una lista de contactos en la subcuenta.

  • URL: https://aio.sigmamovil.com/api/contactlist/edit/{idContactlist}
  • Método: PUT
  • Parámetro:

o idContactlist: El ID que tiene asignado la lista de contactos

  • Datos: Objeto JSON con información de la lista de contactos.

Integraciones Sigma Móvil-contacto

Integraciones Sigma Móvil-contacto

Eliminar lista de contactos:

Este servicio elimina una lista de contactos en la subcuenta. Esta eliminación es lógica, es decir el registro no se elimina de la base de datos pero en la plataforma ya no se visualizará.

  • URL: https://aio.sigmamovil.com/api/contactlist/delete/{idContactlist}
  • Método: DELETE
  • Parámetro:

o idContactlist: El ID que tiene asignado la lista de contactos

  • Datos: No se envían datos

Integraciones Sigma Móvil-contacto

ver campos personalizados

Este servicio retorna todos los campos personalizados que pertenecen a una lista de contactos. También retorna información como el total de registros y el número de páginas, los datos estarán limitados en 15 registros por página.

  • URL:https://aio.sigmamovil.com/api/contactlist/listcustomfield/{idContactlis t}/{pagina}
  • Método: GET
  • Parámetro:

o idContactlist: El ID que tiene asignado la lista de contactos.
o página: El número de la página.

ejemplo:

Integraciones Sigma Móvil-campo-personalizado

Crear campos personalizados

Este servicio crea un nuevo campo personalizado en una lista de contactos perteneciente a una subcuenta.

  • URL:https://aio.sigmamovil.com/api/contactlist/addcustomfield
  • Método: POST
  • Datos: Objeto JSON con información del campo personalizado.

ejemplo:

Integraciones Sigma Móvil-campo-personalizado

Editar campos personalizados

Este servicio edita un campo personalizado en una lista de contactos perteneciente a una subcuenta.

  • URL:https://aio.sigmamovil.com/api/contactlist/editcustomfield/{idCustomfi eld}
  • Método: PUT
  • Parámetro:

o idCustomfield: El ID que tiene asignado el campo personalizado.

• Datos: Objeto JSON con información del campo personalizado

Ejemplo:

Integraciones Sigma Móvil-campo-personalizadoEliminar campos personalizados

Este servicio elimina un campo personalizado de una lista de contactos. Esta eliminación es lógica, es decir el registro no se elimina de la base de datos pero en la plataforma ya no se visualizará.

  • URL:https://aio.sigmamovil.com/api/contactlist/deletecustomfield/{idCusto mfield}
  • Método: DELETE
  • Parámetro:

o idCustomfield: El ID que tiene asignado el campo personalizado.

  • Datos: No se envían datos.

Ejemplo:

Integraciones Sigma Móvil-campo-personalizado

Ver contactos

Este servicio retorna todos los contactos que pertenecen a una lista de contactos. También retorna información como el total de registros y el número de páginas, los datos estarán limitados en 15 registros por página.

  • URL:https://aio.sigmamovil.com/api/contact/getcontacts/{pagina}/{idContac tlist}
  • Método: GET
  • Parámetro:

o idContactlist: El ID que tiene asignado la lista de contactos.

o página: El número de la página.

• Datos: Palabra referente a la búsqueda

Integraciones Sigma Móvilcontacto

Ver contactos por cuenta de usuario

Este servicio retorna todos los contactos que pertenecen a una cuenta. También retorna información como el total de registros y el número de páginas, los datos estarán limitados en 15 registros por página.

  • URL:https://aio.sigmamovil.com/api/contact/getcontactsaccount/{pagina}
  • Método: POST
  • Parámetro:

o página: El número de la página.

  • Datos: Palabra referente a la búsqueda.

Integraciones Sigma Móvil-contacto

Crear contacto

Este servicio crea un nuevo contacto en una lista de contactos perteneciente a una subcuenta.

  • URL:https://aio.sigmamovil.com/api/contact/addcontact/{idConstalist}
  • Método: POST
  • Parámetro:

o idContactlist: El ID que tiene asignado la lista de contactos.

  • Datos: Objeto JSON con información del contacto. Se debe crear un array que contenga los campos primarios y los campos personalizados si desea agregar datos a estos.

Integraciones Sigma Móvil-contacto

Crear contacto por lote

Este servicio crea contactos por lote en una lista de contactos perteneciente a una subcuenta.

  • URL:https://aio.sigmamovil.com/api/contact/addcontactbatch/{idConstalist}
  • Método: POST
  • Parámetro:

o idContactlist: El ID que tiene asignado la lista de contactos.

  • Datos: Se debe enviar un string separado por comas y saltos de línea, cada línea es un contacto. Solo se pueden enviar los campos primarios. Correo electrónico, indicativo del país, número de telefono, nombre, apellido, fecha de nacimiento (dd/mm/aaaa).

Integraciones Sigma Móvil-contacto

Eliminar contacto

Este servicio elimina un contacto de una lista de contactos perteneciente a una subcuenta. Esta eliminación es lógica, es decir el registro no se elimina de la base de datos pero en la plataforma ya no se visualizará.

  • URL:https://aio.sigmamovil.com/api/contact/deleconta/{idContact}/{

idContactlist}

  • Método: DELETE
  • Parámetro:

o idContact: El ID que tiene asignado el contacto.

o idContactlist: El ID que tiene asignado la lista de contactos.

  • Datos: No se envían datos.

Integraciones Sigma Móvil-contacto

Dessuscribir o suscribir contacto

Este servicio des-suscribe o suscribe un contacto de una lista de contactos perteneciente a una subcuenta.

Ejemplo

  • URL:https://aio.sigmamovil.com/api/contact/changestatus/{idContact}/{

idContactlist}

  • Método: GET
  • Parámetro:

o idContact: El ID que tiene asignado el contacto.

o idContactlist: El ID que tiene asignado la lista de contactos.

  • Datos: No se envían datos.

Integraciones Sigma Móvil-contacto

Ver contactos activos de email y sms por cuenta

Este servicio retorna un contacto de una lista de contactos perteneciente a una subcuenta.

  • URL:https://aio.sigmamovil.com/api/contact/activecontacts/{idAccount}
  • Método: GET
  • Parámetro:

o idContactlist: El ID de una cuenta.

  • Datos: No se envían datos.

Integraciones Sigma Móvil-contacto

Crear contactos por lote con campos personalizados

Este servicio crea contactos en una lista de contactos perteneciente a una subcuenta.

  • URL:https://aio.sigmamovil.com/api/contact/addcontactbyblock/{idContactl ist}
  • Método: POST
  • Parámetro:

o idContactlist: El ID que tiene asignado la lista de contactos.

  • Datos: Objeto JSON con información del contacto. Se debe crear un array que contenga en otros arrays los campos primarios y los campos personalizados si desea agregar datos a estos.

Integraciones Sigma Móvil-contacto

Editar contactos con campos personalizados

Este servicio edita un contacto de una lista de contactos perteneciente a una subcuenta. El servicio editara solo los datos que se le envié.

  • URL:https://aio.sigmamovil.com/api/contact/updatecontact/{idContact}
  • Método: POST
  • Parámetro:

o idContact: El ID que tiene asignado el contacto.

• Datos: Objeto JSON con información del contacto. Se debe crear un array que contenga en otros arrays los campos que desea modificar. El array debe tener las propiedades key y value, en las cuales van los valores id del customfield y el nuevo valor respectivamente

Integraciones Sigma Móvil-contacto

Crear envío de mail

Este servicio crea un envío de correo.

  • URL:https://aio.sigmamovil.com/api/mail/newmail
  • Método: POST
  • Datos: Objeto JSON con información del correo. Si se desea enviar contenido HTML, se debe establecer la llave type como html y en la llave content se debe poner el código HTML deseado.

Integraciones Sigma Móvil-contactoIntegraciones Sigma Móvil

Integraciones Sigma Móvil-contacto

Editar envío de mail

Este servicio edita un envío de correo.

  • URL:https://aio.sigmamovil.com/api/mail/editmail/{idMail}
  • Método: PUT
  • Parámetro:

o idMail: El ID que tiene asignado el Mail.

  • Datos: Objeto JSON con información del correo. Si se desea enviar contenido HTML, se debe establecer la llave type como html y en la llave content se debe poner el código HTML deseado.

Integraciones Sigma Móvil-envio

Integraciones Sigma Móvil-envio

Cancelar envío de mail

Este servicio cancela un envío de correo.

  • URL:https://aio.sigmamovil.com/api/mail/cancelmail/{idMail}
  • Método: DELETE
  • Parámetro:

o idMail: El ID que tiene asignado el Mail.

  • Datos: No se envían datos.

Integraciones Sigma Móvil-envio

 

Ver envío de mail

Este servicio retorna la información de un envío de correo.

  • URL:https://aio.sigmamovil.com/api/mail/detailmail/{idMail}
  • Método: GET
  • Parámetro:

o idMail: El ID que tiene asignado el Mail.

  • Datos: No se envían datos.

Integraciones Sigma Móvil-envio

Integraciones Sigma Móvil-envio

Ver detalles de aperturas de un envío de mail

Este servicio retorna la información de aperturas un envío de correo.

  • URL:https://aio.sigmamovil.com/api/statics/datainfo/{idMail}/{pagina}
  • Método: POST
  • Parámetro:

o idMail: El ID que tiene asignado el Mail.

o página: Numero de la página.

  • Datos:

o Route: Se envía el valor open.

o Filters: Ya que está función no tiene filtros disponibles debes enviar el valor -1.

o Type: Ya que está función no tiene filtros disponibles debes enviar el valor “type”.

Integraciones Sigma Móvil-envio

 

Ver detalles de Clics de un envío de mail

Este servicio retorna la información de clics un envío de correo.

  • URL:https://aio.sigmamovil.com/api/statics/datainfo/{idMail}/{pagina}
  • Método: POST
  • Parámetro:

o idMail: El ID que tiene asignado el Mail.

o página: Numero de la página.

  • Datos:

o Route: Se envía el valor clic.

o Filters: Ya que está función no tiene filtros disponibles debes enviar el valor -1.

o Type: Ya que está función no tiene filtros disponibles debes enviar el valor “type”.

integraciones-envio

Ver detalles de dessuscritos de un envío de mail

Este servicio retorna la información de des-suscritos de un envío de correo.

  • URL:https://aio.sigmamovil.com/api/statics/datainfo/{idMail}/{pagina}
  • Método: POST
  • Parámetro:

o idMail: El ID que tiene asignado el Mail.

o página: Numero de la página.

  • Datos:

o Route: Se envía el valor unsuscribe.

o Filters: Ya que está función no tiene filtros disponibles debes enviar el valor -1.

o Type: Ya que está función no tiene filtros disponibles debes enviar el valor “type”.

integraciones-envio

Ver detalles de rebotes de un envío de mail

Este servicio retorna la información de los rebotes un envío de correo.

  • URL:https://aio.sigmamovil.com/api/statics/datainfo/{idMail}/{pagina}
  • Método: POST
  • Parámetro:

o idMail: El ID que tiene asignado el Mail.

o página: Numero de la página.

  • Datos:

o Route: Se envía el valor bounced.

o Filters: Ya que está función no tiene filtros disponibles debes enviar el valor -1.

o Type: Ya que está función no tiene filtros disponibles debes enviar el valor “type”.

integraciones-envio

Ver detalles de spam de un envío de mail

Este servicio retorna la información de spam de un envío de correo.

  • URL:https://aio.sigmamovil.com/api/statics/datainfo/{idMail}/{pagina}
  • Método: POST
  • Parámetro:

o idMail: El ID que tiene asignado el Mail.

o página: Numero de la página.

  • Datos:

o Route: Se envía el valor SPAM.

o Filters: Ya que está función no tiene filtros disponibles debes enviar el valor -1.

o Type: Ya que está función no tiene filtros disponibles debes enviar el valor “type”.

integraciones-envio

Crear envío de SMS por listas de contactos

Este servicio crea un envío de SMS por listas de contactos.

  • URL:https://aio.sigmamovil.com/api/sms/createsmssend
  • Método: POST
  • Datos: Objeto JSON con información del SMS.

integraciones-mensajes-de-texto

Editar envío de SMS por listas de contactos

Este servicio edita un envío de SMS por listas de contactos. Se deben de enviar todos los datos que pertenecen a el SMS para realizar la edición correctamente.

  • URL:https://aio.sigmamovil.com/api/sms/editsmssend/{ idSms }
  • Método: PUT
  • Parámetros:

o idSms: El ID que tiene asignado el SMS.

• Datos: Objeto JSON con información del SMS

integraciones-mensajes-de-texto

Cancelar envío de SMS

Este servicio edita un envío de SMS por listas de contactos.

  • URL:https://aio.sigmamovil.com/api/sms/ delete/{ idSms }
  • Método: DELETE
  • Parámetros:

o idSms: El ID que tiene asignado el SMS.

  • Datos: No se envía datos.

integraciones-mensajes-de-texto

Crear envío de SMS por lote

Este servicio crea un envío de SMS por lote.

  • URL:https://aio.sigmamovil.com/api/sms/createsmslote
  • Método: POST

• Datos: Objeto JSON con información del SMS

integraciones-mensajes-de-texto

Crear envío de SMS masivo encriptado

Este servicio crea un envío de SMS masivo encriptado.

  • URL:https://aio.sigmamovil.com/api/sms/createsmsencrypted
  • Método: POST
  • Datos: Objeto JSON con información del SMS. Se debe de enviar la información encriptada en base 64.

integraciones-mensajes-de-texto

Ver envío de SMS masivo encriptado

Este servicio retorna la información de un envío de SMS masivo encriptado.

  • URL:https://aio.sigmamovil.com/api/sms/detailsms/{idSms}
  • Método: GET
  • Parámetro:

o idSms: El ID que tiene asignado el SMS.

  • integraciones-mensajes-de-textoDatos: No se envían datos.

Consultar cantidad de servicio disponible

Este servicio retorna todos los servicios disponibles que tiene un cliente (Modo de servicio, Cantidad total del servicio, cantidad usada, cantidad disponible, nombre del servicio)

  • URL:https://aio.sigmamovil.com/api/subaccoun /getavailableservicesamount

• Método: GET

integraciones-mensajes-de-texto

Consulta de cantidad de sms por subaccount por filtro de fechas

Este servicio retorna la cantidad de sms por subaccount filtrando los registros por fechade programacion

  • URL: https://aio.sigmamovil.com/api/sms/countsaxssms
  • Método: POST
  • Parámetro:

o datestart: formato de fecha (YYY-MM-DD HH-MM-SS)

o dateend: formato de fecha (YYY-MM-DD HH-MM-SS)

  • Datos: Fecha de inicio, fecha final.

integraciones-mensajes-de-texto

Comience su prueba gratuita hoy

PRUEBA GRATIS

Contáctenos para ayudarle a transformar su negocio.

(+57) 3176676693 – (+57) 3183355806 – (+2) 4836921

Calle 15N # 6N-34 – Cali