Visão geral da documentação do Experience Platform

OBSERVAÇÃO

A documentação da Adobe Experience Platform foi movida recentemente. Por favor, reveja a nova navegação e atualize quaisquer marcadores existentes.

A documentação da 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 de 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 da interface do usuário (UI) e da API. Os tipos mais comuns de documentação são resumidos na seguinte lista:

  • Referência da API: consulte a documentação de referência da API de cada serviço para saber mais detalhes sobre os endpoints disponíveis, incluindo cabeçalhos, parâmetros, solicitações de amostra e respostas. Esses materiais de referência não fornecem o mesmo nível de detalhe 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 de uso detalhadas para todos os pontos de extremidade de API disponíveis para um serviço específico. O guia inclui parâmetros de consulta disponíveis, solicitações de amostra e respostas de amostra, bem como outline "gotchas" para evitar ao fazer chamadas para APIs Platform.

  • Visão geral: uma visão geral fornece um outline de alto nível do serviço ou recurso e como ele interage com outros Platform serviços. A visão geral é o melhor lugar 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 para perguntas frequentes e informações relacionadas às mensagens de erro que você provavelmente encontrará ao usar a API. O Experience Platform guia de solução de problemas fornece suporte para perguntas e erros gerais, enquanto serviços individuais fornecem guias de solução de problemas específicos de sua área.

  • Tutorial: um tutorial é um guia passo a passo por meio da interface do usuário, da API ou uma combinação de ambos, que leva a um resultado específico. Diferente de um guia do desenvolvedor, um tutorial de API pode focar apenas em um ou dois endpoints e não é um recurso de API exaustivo. 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. O Tutorials muitas vezes faz parte de um fluxo de trabalho maior e apresenta as "próximas etapas" que descrevem quais tutoriais você pode querer experimentar em seguida.

  • Guia da interface do usuário: um guia da interface do usuário descreve as ações disponíveis na interface do Platform usuário para um serviço específico. Esses documentos contêm capturas de tela e etapas focadas 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 "gotchas" para evitar. Este é o recurso mais detalhado para trabalhar com a interface do usuário do .

Nesta página