Introdução à API Policy Service

A API Policy Service permite criar e gerenciar vários recursos relacionados à Governança de dados do Adobe Experience Platform. Este documento fornece uma introdução aos conceitos principais que você precisa saber antes de tentar fazer chamadas para a API Policy Service.

Pré-requisitos

O uso do guia do desenvolvedor requer uma compreensão funcional dos vários serviços do Experience Platform envolvidos no trabalho com os recursos de Governança de dados. Antes de começar a trabalhar com o Policy Service API, reveja a documentação dos seguintes serviços:

  • Governança de dados: a estrutura pela qual o Experience Platform impõe conformidade com o uso de dados.
  • Experience Data Model (XDM) System: a estrutura padronizada pela qual o Experience Platform organiza os dados de experiência do cliente.
  • Real-Time Customer Profile: Fornece um perfil de consumidor unificado em tempo real com base em dados agregados de várias fontes.
  • Sandboxes: Experience Platform fornece sandboxes virtuais que particionam uma única instância do Platform em ambientes virtuais separados para ajudar a desenvolver aplicativos de experiência digital.

Leitura de chamadas de API de amostra

A documentação da API Policy Service fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. Isso inclui caminhos, cabeçalhos necessários e conteúdos de solicitação formatados corretamente. Também fornece exemplos de JSON retornado nas respostas da API. 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 guia de solução de problemas Experience Platform.

Cabeçalhos obrigatórios

A documentação da API também requer que você tenha concluído o tutorial de autenticação para fazer chamadas com êxito para pontos de extremidade Platform. Concluir o tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários nas chamadas de API Experience Platform, conforme mostrado abaixo:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Todos os recursos em Experience Platform, incluindo aqueles pertencentes à Governança de dados, estão isolados em sandboxes virtuais específicas. Todas as solicitações para Platform APIs exigem um cabeçalho que especifique o nome da sandbox em que a operação ocorrerá:

  • x-sandbox-name: {SANDBOX_NAME}
NOTE
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 um conteúdo (POST, PUT, PATCH) exigem um cabeçalho adicional:

  • Content-Type: application/json

Recursos principais vs. personalizados

Na API Policy Service, todas as políticas e ações de marketing são chamadas de recursos core ou custom.

core recursos são aqueles definidos e mantidos pelo Adobe, enquanto custom recursos são aqueles criados e mantidos pela sua organização e, portanto, são exclusivos e visíveis apenas para a sua organização. Sendo assim, as operações de listagem e pesquisa (GET) são as únicas operações permitidas em core recursos, enquanto as operações de listagem, pesquisa e atualização (POST, PUT, PATCH e DELETE) estão disponíveis para custom recursos.

Próximas etapas

Para começar a fazer chamadas usando a API de serviço de política, selecione um dos manuais de endpoint disponíveis.

recommendation-more-help
834e0cae-2761-454a-be4d-62f0fd4b4456