Tras varios meses de trabajo tenemos el placer de anunciar una actualización de nuestra API REST a la nueva versión V3, con varios cambios y mejoras. Si actualmente trabajas enviando correos electrónicos con tecnología API REST de teenvio, seguramente te interese este artículo para mejorar las campañas de email marketing.
- Publicamos nuevos métodos, entre los que se encuentra el lanzamiento de emails “full request” muy útil en envíos transaccionales de poco volumen y métodos extra para el manejo de creatividades o newsletters.
- Mejorada la estandarización de respuestas, devolviendo estados más coherentes HTTP 200,400, 403, 404 y 500.
- Se permiten peticiones en formato JSON además del clásico form/data o x-www-form-urlencode.
La nueva versión v3 es compatible con las peticiones v2 y durante el año 2022/2023 no sería necesario modificar las integraciones salvo para aprovechar las mejoras en los códigos de error.
¿Qué se ha mejorado en el API REST para email marketing?
- Las respuestas OK no cambian y siguen devolviendo códigos HTTP 200.
- Las respuestas KO en lugar de devolver códigos HTTP 200 ahora devolverá códigos: 400, 403, 404, 405 o 500 en la mayoría de los casos y en función de la naturaleza del error.
- Las credenciales no pueden enviarse con parámetros GET.
- Para mejorar la seguridad, las peticiones siempre serán HTTPS.
- Respuestas en XML o en JSON en función de la cabecera Accept.
- Peticiones en form/data, x-www-form-urlencode o en raw JSON en función de la cabecera Content-Type.
¿Hasta cuándo podré usar la versión v2.9 y qué debo hacer?
La versión anterior v2.9 del API REST para email marketing sólo estará disponible hasta finales del año 2023, por lo que es recomendable ir cambiando lo antes posible las peticiones REST a la nueva URL.
En la mayoría de los casos solo se requerirá el cambio de la URL
https://[xxx].teenvio.com/v4/public/api/rest/v2/
por
https://app.teenvio.com/v4/public/api/rest/v3/
Sólo en el caso de que estuvieses gestionando las respuestas erróneas, deberás revisar que ahora tu integración es capaz de leer códigos de estado HTTP distintos de 200 para leer los posibles mensajes de error.
Si tienes cualquier duda siempre puedes contactar con nuestro departamento de soporte técnico donde disponemos de desarrolladores que pueden revisar el código de tu integración.
¿Se ven afectadas el resto de APIs?
El API POST sigue funcionando, pero se recomienda ir migrando al API REST dadas sus múltiples ventajas.
El API SMTP se mantiene sin cambios, únicamente se van actualizando los requisitos de seguridad:
- Es necesario utilizar cifrado: Se puede utilizar cifrado SMTP en el puerto 46500 o bien conexión en claro por el puerto 2500 ó 58700 pero utilizando STARTLS para iniciar el cifrado.
- El cifrado debe ser TLSv1.2 o superior, quedando fuera el resto de versiones anteriores.
- Si se intenta lanzar el comando de autenticación AUTH LOGIN sin cifrado previo se devolverá error.
Más información en el portal de desarrolladores de teenvio: dev.teenvio.com
