Catalog Service Guia da API

Catalog Service é o sistema de registro para localização e linhagem de dados no Adobe Experience Platform. Catalog O atua como um armazenamento de metadados ou "catálogo", onde é possível encontrar informações sobre seus dados no Experience Platform, sem precisar acessar os dados propriamente ditos. Consulte a Catalog visão geral para obter mais informações.

Este guia do desenvolvedor fornece etapas para ajudá-lo a começar a usar a API Catalog. O guia fornece exemplos de chamadas de API para executar operações principais usando Catalog.

Pré-requisitos

Catalog rastreia metadados para vários tipos de recursos e operações no Experience Platform. Este guia do desenvolvedor requer uma compreensão funcional dos vários serviços Experience Platform envolvidos na criação e no gerenciamento desses recursos:

  • Experience Data Model (XDM): A estrutura padronizada pela qual Platform organiza os dados de experiência do cliente.
  • Ingestão em lote: Como o Experience Platform assimila e armazena dados de arquivos de dados, como CSV e Parquet.
  • Assimilação de fluxo: Como Experience Platform assimila e armazena dados de dispositivos cliente e do lado do servidor em tempo real.

As seções a seguir fornecem informações adicionais que você precisará saber ou ter em mãos para fazer chamadas com êxito para a API Catalog Service.

Lendo exemplos de chamadas de API

Este guia fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações do . Isso inclui caminhos, cabeçalhos necessários e cargas de solicitação formatadas corretamente. O JSON de exemplo retornado nas respostas da API também é fornecido. Para obter informações sobre as convenções usadas na documentação para chamadas de API de exemplo, consulte a seção sobre como ler chamadas de API de exemplo no Experience Platform guia de solução de problemas.

Coletar valores para cabeçalhos necessários

Para fazer chamadas para Platform APIs, primeiro complete o tutorial de autenticação. A conclusão do tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todas as chamadas de API Experience Platform, conforme mostrado abaixo:

  • Autorização: Portador {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Todos os recursos em Experience Platform são isolados para sandboxes virtuais específicas. Todas as solicitações para Platform APIs exigem um cabeçalho que especifica o nome da sandbox em que a operação ocorrerá:

  • x-sandbox-name: {SANDBOX_NAME}
OBSERVAÇÃO

Para obter mais informações sobre sandboxes em Platform, consulte a documentação de visão geral da sandbox.

Todas as solicitações que contêm uma carga útil (POST, PUT, PATCH) exigem um cabeçalho adicional:

  • Tipo de conteúdo: application/json

Práticas recomendadas para chamadas de API Catalog

Ao executar solicitações GET para a API Catalog, a prática recomendada é incluir parâmetros de consulta em suas solicitações para retornar somente os objetos e propriedades necessários. As solicitações não filtradas podem fazer com que as cargas de resposta atinjam mais de 3 GB, o que pode retardar o desempenho geral.

Você pode exibir objetos específicos incluindo sua ID no caminho da solicitação ou usar parâmetros de consulta, como properties e limit para filtrar as respostas. Os filtros podem ser passados como cabeçalhos e como parâmetros de consulta, com aqueles passados como parâmetros de consulta tendo prioridade. Consulte o documento em filtrando dados do catálogo para obter mais informações.

Como algumas consultas podem aumentar a carga da API, limites globais foram implementados em consultas Catalog para oferecer suporte adicional às práticas recomendadas.

Próximas etapas

Este documento cobriu o conhecimento de pré-requisito necessário para fazer chamadas para a API Catalog. Agora você pode prosseguir para as chamadas de exemplo fornecidas neste guia do desenvolvedor e seguir com suas instruções.

A maioria dos exemplos neste guia usa o endpoint /dataSets, mas os princípios podem ser aplicados a outros endpoints no Catalog (como /batches e /accounts). Consulte a Referência da API do Serviço de Catálogo para obter uma lista completa de todas as chamadas e operações disponíveis para cada endpoint.

Para obter um fluxo de trabalho passo a passo que demonstra como a API Catalog está envolvida com a assimilação de dados, consulte o tutorial em criar um conjunto de dados.

Nesta página