Información general sobre la documentación del Experience Platform

NOTA

La documentación de Adobe Experience Platform se ha trasladado recientemente. Tómese un momento para revisar la nueva navegación y actualizar los marcadores existentes.

La documentación de Adobe Experience Platform está disponible para una serie de funciones y servicios de la Plataforma. Para acceder a la documentación de Experience Platform, vuelva a la página de aterrizaje de documentación y seleccione la guía que desee vista.

Tipos de documentación del Experience Platform

La documentación de Experience Platform se proporciona en varios formatos, como descripciones generales, tutoriales y guías tanto para la interfaz de usuario (IU) como para la API. Los tipos de documentación más comunes se resumen en la siguiente lista:

  • Referencia de API: consulte la documentación de referencia de API de cada servicio para obtener más información sobre los extremos disponibles, incluidos encabezados, parámetros, solicitudes de muestra y respuestas. Estos materiales de referencia no proporcionan el mismo nivel de detalle que la documentación. Se recomienda consultar la guía para desarrolladores específica del servicio para obtener ejemplos detallados de uso de API.

  • Guía para desarrolladores: Cada guía para desarrolladores proporciona información detallada sobre el uso de todos los extremos de API disponibles para un servicio específico. La guía incluye parámetros de consulta disponibles, solicitudes de muestra y respuestas de muestra, así como un esquema de "problemas" que se deben evitar al realizar llamadas a Platform API.

  • Información general: Una descripción general proporciona un esquema de alto nivel del servicio o función y de cómo interactúa con otros Platform servicios. La información general es el mejor lugar para el inicio al conocer las nuevas funciones y funcionalidades dentro de Platform.

  • Guía de solución de problemas: utilice la guía de solución de problemas para encontrar respuestas a las preguntas más frecuentes e información sobre los mensajes de error que probablemente se encuentren al utilizar la API. La guía de solución de problemas Experience Platform proporciona soporte para preguntas generales y errores, mientras que los servicios individuales proporcionan guías de resolución de problemas específicas de su área.

  • Tutorial: Un tutorial es una guía paso a paso a través de la interfaz de usuario, la API o una combinación de ambos, que lleva a un resultado específico. A diferencia de una guía para desarrolladores, un tutorial de API solo puede centrarse en uno o dos extremos y no es un recurso API exhaustivo. Del mismo modo, los tutoriales de la interfaz de usuario pueden centrarse únicamente en pasos específicos, no en la interfaz de usuario completa disponible para ese servicio. Los Tutorials suelen formar parte de un flujo de trabajo más amplio y presentan los "próximos pasos" que describen los tutoriales que puede que desee probar a continuación.

  • Guía de interfaz de usuario: una guía de interfaz de usuario describe las acciones disponibles en la interfaz de Platform usuario para un servicio específico. Estos documentos contienen capturas de pantalla y pasos centrados en la interacción con Platform a través de la interfaz de usuario. Al igual que una guía para desarrolladores, la guía de la interfaz de usuario describe todas las acciones y opciones disponibles, incluidas las "dificultades" que se deben evitar. Se trata del recurso más detallado para trabajar con la interfaz de usuario.

En esta página