Visão geral da documentação do Experience Platform
A documentação do Adobe Experience Platform está disponível para vários recursos e serviços da plataforma. Para acessar a documentação do Experience Platform, volte para a landing page da documentação e selecione o guia que deseja visualizar.
Tipos de documentação do Experience Platform
A documentação do Experience Platform é fornecida em vários formatos, incluindo visões gerais, tutoriais e guias para a interface do usuário e a API. Os tipos de documentação mais comuns estão resumidos na seguinte lista:
-
Referência da API: Consulte a documentação de referência da API para cada serviço para saber mais sobre os endpoints disponíveis, incluindo cabeçalhos, parâmetros, exemplos de solicitações e respostas. Esses materiais de referência não fornecem o mesmo nível de detalhes que a documentação. É recomendável consultar o guia do desenvolvedor específico do serviço para obter exemplos detalhados de uso da API.
-
Guia do desenvolvedor: Cada guia do desenvolvedor fornece informações detalhadas de uso para todos os endpoints de API disponíveis para um serviço específico. O guia inclui parâmetros de consulta disponíveis, exemplos de solicitações e exemplos de respostas, além de destacar as "armadilhas" que devem ser evitadas ao fazer chamadas para o Platform APIs.
-
Visão geral: Uma visão geral fornece uma descrição de alto nível do serviço ou recurso e como ele interage com outros Platform serviços. A visão geral é o melhor local para começar a aprender sobre novos recursos e funcionalidades no Platform.
-
Guia de solução de problemas: Use o guia de solução de problemas para encontrar respostas a perguntas frequentes e informações sobre mensagens de erro que você provavelmente encontrará ao usar a API. A variável Experience Platform o guia de solução de problemas fornece suporte para perguntas gerais e erros, enquanto os serviços individuais fornecem guias de solução de problemas específicos para sua área.
-
Tutorial: Um tutorial é um guia passo a passo pela interface do usuário, pela API ou por uma combinação de ambas, que leva a um resultado específico. Diferentemente de um guia do desenvolvedor, um tutorial de API só pode se concentrar em um ou dois endpoints e não é um recurso de API completo. Da mesma forma, os tutoriais da interface do usuário podem se concentrar apenas em etapas específicas, não na interface do usuário completa disponível para esse serviço. Os Tutorials geralmente fazem parte de um fluxo de trabalho maior e apresentam as "próximas etapas" que descrevem quais tutoriais você pode experimentar em seguida.
-
Guia da interface do usuário: Um guia da interface do usuário descreve as ações disponíveis no Platform para um serviço específico. Esses documentos contêm capturas de tela e etapas com foco na interação com a Platform por meio da interface do usuário. Semelhante a um guia do desenvolvedor, o guia da interface do usuário descreve todas as ações e opções disponíveis, incluindo as "armadilhas" que devem ser evitadas. Este é o recurso mais detalhado para trabalhar com a interface do usuário do .