Blog |
Guías

5 buenas prácticas para el consumo de API con SSJS

19/7/2023

5 buenas prácticas para el consumo de API con SSJS en Salesforce Marketing Cloud

Salesforce Marketing Cloud (SFMC) es una herramienta de Marketing Automation utilizada por organizaciones. Cuenta con diversas herramientas, tanto declarativas (point-and-click), como programáticas (con código). Entre los lenguajes exclusivos de Marketing Cloud, se encuentra Server Side Javascript. Este lenguaje, es la mejor opción si es que AMPscript no cumple con los requisitos para el caso de uso a desarrollar, entre ellas, se encuentra el consumo de APIs, ya sean de Salesforce Marketing Cloud o APIs externas.

Al ser un lenguaje de programación ideal para estos casos, es necesario tener en cuenta las mejores prácticas al momento de desarrollarlo. En este blog exploraremos 5 prácticas recomendadas que puedes implementar en tu equipo de desarrollo de Marketing Cloud.

1. Asegura tus credenciales

Construir aplicaciones dentro de Marketing Cloud representa un reto, ya que no cuenta con una infraestructura adecuada para generar credenciales. Sin embargo, existen herramientas que nos permiten superar essta limitación a través de “workarounds”. Al no ser una herramienta 100 por ciento dedicada a las aplicaciones que se generan en Cloud Pages, debemos tener ciertas precauciones, como el uso de credenciales, usar las adecuadas y guardarlas de una manera segura y eficaz.

Para esto, recomendamos lo siguiente:

  1. Crear una Data Extensions con sus credenciales para integraciones de servidor a servidor.
  2. Usar la función de AMPscript EncryptSymmetric para guardarlas en la misma Data Extension.
  3. Para obtener el token (o llaves para pedir un token) se pueden usar las funciones Lookup para buscar a la misma Data Extension del paso 1 y DecryptSymmetric para desencriptar.
%%[
SET @lookUp = LookupRows('API_Integrations','Nombre','JourneyAPI')
SET @rowResult = Row(@lookup,1)
SET @clientId = DecryptSymmetric(Field(@rowResult,'Client Id'),'aes', 'INT_PWD', @null, 'INT_SALT', @null, 'INT_IV', @null)
SET @clientSecret = DecryptSymmetric(Field(@rowResult,'Client Secret'),'aes', 'INT_PWD', @null, 'INT_SALT', @null, 'INT_IV', @null)
SET @tenantId = Field(@rowResult,'Tenant Id')
SET @oldToken = DecryptSymmetric(Field(@rowResult,'Token'),'aes', 'INT_PWD', @null, 'INT_SALT', @null, 'INT_IV', @null)
SET @expirationDate = Field(@rowResult,'ExpirationDate')
]%%

2. Usa try... catch

Cada vez que vayamos a consultar alguna API vía SSJS, tenemos la ventaja de los bloques de try…catch. Esta práctica nos ayuda a generar un log de errores (como veremos más adelante) y hacer un manejo correcto de error, como mandar a una errorpage a nuestros usuarios. 

Es importante destacar que no todo el código debe estar envuelto en un try…catch, sino, solamente lo que pueda representar un riesgo para nuestro código o lógica.
//Código para preparar nuestro llamado
var req = new Script.Util.HttpRequest("http://www.example.com/");
req.emptyContentHandling = 0;
req.retries = 2;
req.continueOnError = true;
req.setHeader("headerTest", "test header value");
req.method = "POST";
req.postData = "testing=testValue1";
try {
//Llamado API
var resp = req.send();
} catch (e) {
SendLog(e.message)
Redirect(errorPage, true)
}

3. Genera un log de errores

Otra buena práctica es tener una Data Extension que contenga al menos los siguientes datos:

  1. Columna de Id
  2. Columna de fecha y hora del error
  3. Columna de identificador del script que presentó el error (esto permite escalabilidad en el desarrollo)
  4. Columna de urgencia
  5. Columna de texto que permita guardar un JSON con información variable, dependiendo del llamado API o script para tener el contexto completo del error.

Esta Data Extension también puede vincularse a un proceso de backup mediante Automation Studio y configurarse alertas por correo electrónico.

4. Usa el objeto HttpRequest

Dentro de SSJS contamos con tres formas de hacer llamados HTTP: 

  1. HTTP.Post y HTTP.Get
  2. Platform.Function.HTTPGet y Platform.Function.HTTPPost
  3. Script.Util.HttpRequest

Para hacer llamados API, es recomendable usar Script.Util.HttpRequest ya que tiene la ventaja de tener un mejor manejo de errores y la construcción del objeto es más fácil y muy flexible, a comparación de las otras dos opciones. 

Script.Util.HttpRequest cuenta con otros métodos HTTP como Delete, Put, Patch, Head y Options, además de tener la propiedad de continueOnError que nos permite un manejo óptimo de errores e intentos nuevos para las consultas API, mismas que se pueden configurar con lo propiedad retries.

Aún así, HTTP.Post, HTTP.Get, Platform.Function.HTTPGet y Platform.Function.HTTPPost son buenas opciones para llamados sencillos o scripts que tengan una corta vida útil y/o se requiera de maximización de tiempos al momento de desarrollar.

5. Usa el Code Resource de JSON

Una de las grandes diferencias entre el desarrollo en Sales Cloud y SFMC, es la posibilidad de exponer web services y extender de esta manera las integraciones. En SFMC, no hay una manera estándar, sin embargo, existen algunos workarounds por medio de SSJS y AMPscript, uno de esos, es el uso de los Code Resources de tipo JSON, mismos que pueden ejecutar SSJS, y por lo tanto, escribir un JSON como respuesta que permita comunicarse con diversos sistemas, tanto como webhook como un endpoint custom en SFMC.

Al seguir estas 5 buenas prácticas para el consumo de APIs con SSJS en Salesforce Marketing Cloud, podrás optimizar tus desarrollos y garantizar un funcionamiento confiable de tus integraciones. Asegura tus credenciales, utiliza bloques try...catch para manejar los errores, registra y gestiona los errores en una Data Extension, aprovecha el objeto HttpRequest para realizar llamadas a APIs y explora el uso del recurso Code Resource de JSON para extender tus integraciones.

¿Quieres saber más? ¡Contáctanos!

Alfredo Ledesma

6x Salesforce Certified

entradas RECIENTES

Guías

Iniciando con Salesforce Data Cloud: Guía para Empresas

Descubre cómo comenzar a utilizar Salesforce Data Cloud para impulsar tu negocio con análisis de datos, automatización de marketing y personalización. Te contamos cómo funciona, que funcionalidades incluye, y que beneficios puede traer para tu empresa.
Guías

Data Cloud: ¿Qué es y para qué sirve?

Descubre Salesforce Data Cloud, una solución integral para gestionar y analizar datos de manera eficiente. Aprovecha sus potentes capacidades para personalizar la experiencia del cliente y mejorar tus estrategias de marketing. Únete a nuestro webinar "Data Cloud 101: Descubre el Potencial de la Data en Tiempo Real" el 29 de febrero a las 12 pm CDMX. Regístrate ahora y lleva tus conocimientos al siguiente nivel.
Guías

3 Reglas de Accesibilidad para Mejorar la Comunicación de tus Emails

En esta ocasión, Ro, nuesto Marketing Champion, te compartirá de su experiencia para ayudarte a descubrir cómo mejorar la comunicación de tus correos electrónicos aplicando estas 4 reglas de accesibilidad. ¡Optimiza tu comunicación digital y haz que cada correo cuente!