Introdução à API Policy Service

A API Policy Service permite criar e gerenciar 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 API Policy Service.

Pré-requisitos

O uso do guia do desenvolvedor requer uma compreensão funcional dos vários serviços 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:

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

Lendo exemplos de chamadas de API

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 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.

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. A conclusão do tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em chamadas de API Experience Platform, conforme 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 aqueles pertencentes a Data Governance, 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:

  • 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 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 na sua Organização IMS. Dessa forma, as operações de listagem e pesquisa (GET) são as únicas operações permitidas nos recursos core, enquanto as operações de listagem, pesquisa e atualização (POST, PUT, PATCH e DELETE) estão disponíveis para os recursos custom.

Próximas etapas

Para começar a fazer chamadas usando a API do serviço de política, selecione um dos guias de ponto de extremidade disponíveis.

Nesta página