Esta es una traducción que desde EGA Futura ofrecemos como cortesía a toda la Ohana y comunidad de programadores, consultores, administradores y arquitectos de Salesforce para toda Iberoamérica.
El enlace a la publicación original, lo encontrarás al final de este artículo.
…
Salesforce Marketing Cloud expone un amplio conjunto de API que le permiten integrar su instancia de Marketing Cloud con sistemas de terceros en una variedad de escenarios. Existe una sólida documentación sobre las API disponibles, pero queríamos ofrecer una forma rápida y sencilla de empezar a utilizar dichas API, así como de comprender los detalles y ver ejemplos de llamadas.
En este post, te presentaré a Postman y te mostraré cómo explorar y probar fácilmente diferentes APIs de Marketing Cloud contra múltiples instancias usando una colección de Postman de código abierto. Esta colección no oficial contiene actualmente más de 140 plantillas de llamadas a la API para las API de Marketing Cloud tanto REST como SOAP.
Acerca de Postman
Postman es una aplicación de escritorio que permite configurar y llamar a APIs basadas en HTTP como REST o SOAP. Es una herramienta muy conveniente y poderosa que aprovecha la configuración de apuntar y hacer clic. Soporta variables de entorno, espacios de trabajo en equipo y automatización de JavaScript entre otras características útiles.
Presentación de la colección de API de Salesforce Marketing Cloud
Un poco de historia
Históricamente, un grupo interno de ingenieros y arquitectos de soluciones creaba y mantenía una colección estática de llamadas comunes y almacenaba esa colección en GitHub. Esta es la colección que muchos de ustedes han almacenado y están utilizando hoy en día.
Desde que se lanzó esta colección inicial, ocurrieron dos cosas importantes que cambiaron la base de la colección. En octubre de 2018, Marketing Cloud introdujo subdominios específicos para inquilinos con el fin de mejorar el rendimiento de la plataforma de Marketing Cloud. Además, en noviembre de 2020, Postman anunció el lanzamiento de Espacios de trabajo públicos, que nos permitió ofrecer una colección de referencia y aprovechar las contribuciones de la comunidad para seguir construyendo y mejorando la colección.
Resumen de la colección
Hoy en día, la colección de Marketing Cloud puede encontrarse en la página del equipo Postman Salesforce Developers, y las instrucciones de configuración y uso pueden encontrarse en GitHub. La colección incluye más de 140 plantillas de solicitud agrupadas por categoría de producto, arquitectura/protocolo y, por último, capacidad del producto.
- Categoría de producto– actualmente la colección es compatible con las partes de Messaging y Journeys de Marketing Cloud. En el futuro saldrán más mejoras para añadir otras categorías de productos.
- Arquitectura/Protocolo – dado que Marketing Cloud admite múltiples enfoques para la integración de API, hemos categorizado las capacidades para alinearlas con la arquitectura REST y el protocolo SOAP. Dado que los patrones para la integración SOAP son similares, la colección proporciona ejemplos para todos los métodos pero no todos los objetos, actualmente. Esta es una gran oportunidad para la colaboración de la comunidad para continuar construyendo esta porción de la colección.
- Capacidad del producto – en este nivel, estamos viendo las peticiones individuales agrupadas por capacidad dentro del producto. Por ejemplo, las solicitudes pertinentes a la creación de nuevos activos de Content Builder, el envío de mensajes transaccionales, o la interacción con las extensiones de datos, por nombrar algunos.
- Las solicitudes de los productos de la industria de la construcción
Construir a partir de plantillas de solicitud de API en lugar de ir a la documentación de cada API puede ahorrarle mucho tiempo y reducir en gran medida el riesgo de errores. Sin embargo, la Colección de APIs de Salesforce Marketing Cloud no sustituye a la documentación. Tendrá que utilizar Postman en combinación con la documentación de la API
Variables y autorización
La colección aprovecha las variables para obtener la máxima flexibilidad. Esto nos permite construir dinámicamente peticiones basadas en la configuración suministrada por el usuario final. Hay cuatro variables clave definidas en el nivel de la colección que tendrá que configurar para utilizar la colección.
-
et_subdominioet_clientId- Los datos de la colección se definen a nivel de la colección
et_clientSecretEsta es la información de la que dispone el cliente
et_mid
En las instrucciones de instalación de la colección se pueden encontrar instrucciones detalladas sobre cómo configurarlas
Hemos querido facilitar al máximo el uso de esta colección. Parte de eso incluye la automatización de la autorización con un script de pre-solicitud a nivel de la colección. Si estás interesado en los detalles de cómo funciona el script de pre-solicitud puedes encontrar más información aquí.
¿Qué significa esto para ti como usuario de la colección? Significa que no tienes que emitir manualmente la llamada de autorización o copiar y pegar ese token de autorización en todas las futuras solicitudes. Bastante bien, ¿verdad?
Múltiples instancias/entornos
Es posible que trabaje con múltiples instancias de Marketing Cloud que admitan escenarios dev/test/prod. Cambiar manualmente las variables de colección cada vez que cambias de instancia sería un dolor… pero gracias a Postman Environments, puedes ahorrar un tiempo precioso. Consulte la documentación de configuración de entornos para obtener más información.
Ejemplo de caso de uso: crear un activo
Antes de saltar al ejemplo, asegúrate de completar el siguiente trabajo previo:
- Instala Postman.
- Importe la Colección de APIs de Salesforce Marketing Cloud y siga el readme del proyecto para instrucciones.
Para el propósito de este ejemplo, usted será un desarrollador en Makana Health, una organización sanitaria ficticia. Se le ha encargado la integración de un sistema de gestión de contenidos (CMS) con Marketing Cloud a través de la API. El objetivo es que los activos se publiquen automáticamente en Marketing Cloud sin que los usuarios tengan que cargarlos manualmente.
En este escenario, el CMS realizará una solicitud para importar un activo a Marketing Cloud una vez que el activo haya sido aprobado. Antes de empezar a desarrollar el proceso de construcción de esta integración, querrá hacer algunas pruebas con la API para entender cómo debe estructurarse la solicitud, cómo es el cuerpo de la respuesta y cómo reside el activo en Marketing Cloud.
Como siempre, un buen comienzo es dirigirse a la documentación de la API para conocer el uso de la solicitud y los campos necesarios.
Ahora que sabes más sobre la solicitud de la API, vamos a crearla en Postman:
Seleccione Messaging & Journeys → REST → Assets (Content Builder) → Content → Create Asset – Image request.
- Provea un nombre para el activo en la propiedad
name. Este será el nombre de visualización del activo en el Content Builder. - Vamos a subir un tipo de activo PNG, por lo que podemos dejar los detalles de assetType como están. Si subes un tipo de activo diferente puedes hacer cambios basándote en la documentación sobre el tipo de activo.
- Provea un nombre para el archivo en la propiedad
FileProperties.fileName. Este será el nombre del activo almacenado en Marketing Cloud. - Busca una imagen PNG que quieras subir. Utilice un servicio como this para convertirla a Base64 y pegue la cadena resultante como valor de la propiedad
file.
Presiona el botón Enviar y ya está Deberías ver un Estado 201 – Creado y ahora verás tu nuevo activo en el Content Builder para utilizarlo en varios mensajes de Marketing Cloud y páginas de destino.
Ahora puedes:
Reproducir la solicitud a voluntad en su entorno de desarrollo o de pruebas y ayudar a solucionar posibles problemas
- Generar y compartir el código para realizar esta llamada en varios lenguajes de programación
- Utilice sus hallazgos para ayudar a diseñar la integración entre su CMS y Marketing Cloud
Resumen
Ahora que conoces a Postman y esta gran colección de APIs, sigue las instrucciones de cómo empezar y explora las APIs de Marketing Cloud. No encuentras la solicitud de API que necesitas en la colección? No dude en contribuir al repositorio, ¡es de código abierto!
En la hoja de ruta de la colección tenemos la intención de ampliar la colección SOAP para Messaging & Journeys, así como añadir las categorías de Interaction Studio y Pardot y las solicitudes de apoyo.
Aaron Cates es arquitecto principal de Marketing Cloud en Salesforce con sede en el centro de Arkansas. Da soporte a la unidad operativa de Sanidad y Ciencias de la Vida en la Nube de Marketing ayudando a los clientes a mejorar la experiencia de sus miembros y pacientes. Actualmente cuenta con certificación 9x de Salesforce y disfruta aprendiendo continuamente sobre nuevas tecnologías tanto dentro como fuera de Salesforce.
Salesforce Marketing Cloud expone un amplio conjunto de APIs que le permiten integrar su instancia de Marketing Cloud con sistemas de terceros en una variedad de escenarios. Existe una sólida documentación sobre las API disponibles, pero queríamos ofrecer una forma rápida y sencilla de empezar a utilizar esas API, así como de entender […]
El post Explore las API de Salesforce Marketing Cloud con una colección de Postman apareció primero en Blog de desarrolladores de Salesforce.
Esta es una traducción realizada por EGA Futura, y este es el link a la publicación original: https://developer.salesforce.com/blogs/2021/04/explore-the-salesforce-marketing-cloud-apis-with-a-postman-collection.html
