El objetivo de este documento es brindar una guía para el correcto consumo del servicio API de Masivapp para envió de emails. El consumo de nuestra API te ofrece los siguientes beneficios:
✔ Facilidad de integración: Proporciona una forma estandarizada y estructurada de comunicación entre sistemas.
✔ Escalabilidad: Al integrar el API, la aplicación puede escalar más fácilmente al aprovechar los recursos o servicios proporcionados por Masiv ya que permite adaptarse a cambios en la demanda sin necesidad de grandes inversiones en infraestructura.
✔ Funcionalidad extendida: El API ofrece acceso a una amplia gama de funcionalidades que pueden enriquecer tu aplicación.
✔ Colaboración y conectividad: El API permiten la conectividad entre diferentes sistemas y aplicaciones, lo que fomenta la colaboración entre plataformas.
En resumen, la integración con nuestra API es una herramienta poderosa que puede ayudar a las empresas a mejorar sus procesos de envió de notificaciones de correo electrónico y la experiencia de sus usuarios.
A continuación se muestra la url y el método donde el API recibe las peticiones de envío:
| Método | URL |
|---|---|
| POST | **https://api.masiv.masivian.com/email/v1/delivery** |
A continuación se definen los prerrequisitos a tener en cuenta antes de enviar un email:
Restricciones de envío para Colombia (Ley 2300 y RNE):
El API Transaccional de Email cuenta con la funcionalidad de aplicar las restricciones de envío que dicta la Ley 2300 o Ley de Toques para Colombia, así cómo la validación sobre el RNE (La Ley 2300 de Colombia regula los envíos de mensajes de texto con contenido de publicidad y/o cobranza para limitar la cantidad de envíos que se realizan a los usuarios finales y para que además se realicen dentro de los horarios permitidos: de lunes a viernes de 7:00 a.m. a 7:00 p.m., y sábados de 8:00 a.m. a 3:00 p.m., excluyendo domingos y festivos.).
Para que el API aplique las validaciones sobre restricciones, es necesario que se habiliten dichas características en la configuración de la cuenta, el personal de Masiv tiene la capacidad de ajustar la configuración para habilitar las restricciones.
<aside> 💡
Nota: Aclaración sobre cumplimiento de la normativa 2300 y consulta del RNE
El API realiza las validaciones necesarias para asegurar el cumplimiento de la Ley 2300 y consulta del Registro Nacional de Exclusiones (RNE), siempre y cuando las restricciones y parámetros asociados estén activos en la cuenta desde la cual se está efectuando el consumo.
</aside>
La autenticación básica es un esquema de autenticación simple integrado en el protocolo HTTP. Para usarlo, envíe sus solicitudes HTTP con un encabezado de Authorization que contenga la palabra Basic seguida de un espacio y una cadena codificada en base64 correspondiente a usuario:contraseña, como se muestra a continuación:
| Nombre | Valor | Descripción | Obligatoriedad |
|---|---|---|---|
| Authorization | Basic <Token> | Cabecera de autenticación de tipo Basic Auth, el token debe contener la estructura de usuario:contraseña codificada en base 64 y corresponder a un usuario de Masiv válido. | Requerido |
Ejemplo de encabezado para realizar peticiones a la API codificando usuario:contraseña en base 64.
Authorization: Basic dXN1YXJpbzpjb250cmFzZcOxYQ==