Introdução ao Policy Service API

A variável Policy Service A API 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 o Policy Service API.

Pré-requisitos

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

Governança de dados: a estrutura pela qual Experience Platform aplica a conformidade com o uso de dados.
Experience Data Model (XDM) System: o quadro normalizado pelo qual 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 O fornece sandboxes virtuais que particionam uma única Platform em ambientes virtuais separados para ajudar a desenvolver aplicativos de experiência digital.

Leitura de chamadas de API de amostra

A variável Policy Service A documentação da 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 exemplo de JSON 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.

Cabeçalhos obrigatórios

A documentação da API também exige que você tenha concluído a tutorial de autenticação para fazer chamadas com êxito para o Platform pontos finais. Concluir o tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários no Experience Platform Chamadas de API, 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 ao Data Governance, são isolados em sandboxes virtuais específicas. Todas as solicitações para Platform As APIs exigem um cabeçalho que especifique o nome da sandbox em que a operação ocorrerá:

x-sandbox-name: {SANDBOX_NAME}

OBSERVAÇÃO

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

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

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

core os recursos são os definidos e mantidos pela 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. Como tal, 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.