Introdução à Policy Service API

A Policy Service API permite que você crie e gerencie vários recursos relacionados ao Adobe Experience Platform Data Governance. Este documento fornece uma introdução aos conceitos principais que você precisa saber antes de tentar fazer chamadas para a Policy Service API.

Pré-requisitos

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

  • Data Governance: A estrutura pela qual Experience Platform aplica a conformidade de uso de dados.
  • Sistema do Experience Data Model (XDM): A estrutura padronizada pela qual Experience Platform organiza os dados de experiência do cliente.
  • Perfil do cliente em tempo real: Fornece um perfil unificado e em tempo real para o consumidor, com base em dados agregados de várias fontes.
  • Caixas de proteção: Experience Platform fornece caixas de proteção virtuais que particionam uma única Platform instância em ambientes virtuais separados para ajudar a desenvolver e desenvolver aplicativos de experiência digital.

Lendo chamadas de exemplo da API

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

Cabeçalhos obrigatórios

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

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

Todos os recursos em Experience Platform, incluindo os pertencentes a Data Governance, são isolados para caixas de proteção virtuais específicas. Todas as solicitações para Platform APIs exigem um cabeçalho que especifique o nome da caixa de proteção em que a operação ocorrerá:

  • x-sandbox-name: {SANDBOX_NAME}
Observação

Para obter mais informações sobre caixas de proteção em Platform, consulte a documentação de visão geral dacaixa de proteção.

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

  • Content-Type: application/json

Recursos principais vs. personalizados

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

core os recursos são aqueles definidos e mantidos pelo Adobe, enquanto custom os 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 IMS. Dessa forma, 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, PATCHe 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 guias de ponto de extremidade disponíveis.

Nesta página