Conozca los documentos mejorados para desarrolladores de Pardot ☁️

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.

…

Hemos refactorizado la documentación de la API de Pardot para que sea más fácil que nunca el uso de nuestras API, y presentaremos estos cambios el 7 de mayo de 2021. Desde contenido nuevo hasta muestras de código actualizado y puntos finales recién documentados, He trabajado muy duro para hacer que los documentos sean más útiles, coherentes y organizados. ¿Quiere saber cuánto ha cambiado? Hemos realizado 4.891 adiciones y 3.085 eliminaciones. Hagamos un recorrido por los nuevos documentos.

Mejor organizacion

Hemos reorganizado la documentación para cada objeto, dividiendo cada tema en secciones consistentes y dándoles esquemas claros. La tabla de contenido en el lado izquierdo de la página le permite saltar entre métodos y secciones dentro de cada método; esto es útil para algunos de nuestros temas más extensos. El mayor cambio es la tabla de recursos incluida al principio del tema de cada objeto. Esta tabla describe y describe las operaciones admitidas y los vínculos al contenido relevante, para que pueda buscar rápidamente lo que necesita.

Comencemos con la tabla de recursos y el esquema del tema en nuestra documentación de objetos, usando el objeto Prospect como ejemplo.

Tema del objeto antes

Tenga en cuenta que no hay introducción y el tema simplemente se inicia en la consulta de prospectos. La tabla de contenido de la izquierda es difícil de escanear y algunas de las entradas no son claras.

Tema del objeto después

Hemos agregado un texto introductorio para que se oriente. Tenga en cuenta que la tabla de contenido de la izquierda es más fácil de escanear, y hemos reemplazado entradas vagas como «Usar prospectos» con los nombres de recursos, como «Asignar prospectos». Sin embargo, el mayor cambio es la tabla de Recursos. Aquí, enumeramos todos los recursos disponibles para un objeto, las operaciones admitidas y una breve descripción del recurso. Como beneficio adicional, tenemos un vínculo a la entrada del recurso en la tabla, para que pueda acceder directamente a la información que necesita.

Fuimos aún más lejos al organizar y estandarizar las secciones para cada recurso. Cada tema se divide en secciones por recurso, y cada recurso contiene información útil como el URI (también conocido como el punto final), parámetros y ejemplos.

Sección de recursos antes

Sección de recursos después

Los resultados de todos estos cambios son documentos que son más fáciles de navegar y escanear.

Muestras de código actualizadas

Hemos revisado y actualizado nuestros ejemplos de código para asegurarnos de que tengan contexto y sean relevantes, precisos y completos. También actualizamos los encabezados de autenticación para reflejar los nuevos requisitos de OAuth.

Muestra de código antes

Los ejemplos de código antiguo con frecuencia carecían de contexto o datos realistas.

Muestra de código después

Los nuevos ejemplos de código incluyen encabezados obligatorios, datos de muestra más realistas y contexto para orientarlo en cada tarea.

Documentos conceptuales nuevos y actualizados

Hemos editado nuestros temas conceptuales para hacerlos más breves, más claros y más fáciles de leer. También hemos agregado varios recursos nuevos para ayudarlo a inspirarse y comenzar. Consulte la Guía de introducción y los Ejemplos de casos de uso de API .

Conclusión

Sabemos que el cambio puede ser abrumador y hemos realizado muchos cambios en los documentos de desarrollo. La nueva organización, los ejemplos de código y los documentos conceptuales se actualizaron para ayudarlo a aprovechar al máximo Pardot. ¡Esperamos que los ames!

Puede informar cualquier problema que encuentre abriendo un problema en GitHub .