Show Menu
TÓPICOS×

Guia do desenvolvedor da API do serviço de política DULE

A DULE (Data Usage Labeling and Implementation) é o mecanismo principal do Adobe Experience Platform Data Governance. O DULE Policy Service fornece uma RESTful API que permite criar e gerenciar políticas de uso de dados para determinar quais ações de marketing podem ser tomadas em relação aos dados rotulados com determinados rótulos de uso de dados.
Este documento fornece instruções para executar as operações principais disponíveis na API do Serviço de Política. Caso ainda não o tenha feito, comece por revisar a visão geral do Data Governance para se familiarizar com a estrutura DULE. Para obter instruções passo a passo sobre como criar e aplicar políticas DULE, consulte o tutorial da política DULE.
Este documento fornece uma introdução aos conceitos principais que você precisa saber antes de tentar fazer chamadas para a API de serviço de política.

Introdução ao serviço de política DULE

Antes de começar a trabalhar com o Serviço de política, os dados na plataforma da experiência devem ter as etiquetas DULE apropriadas aplicadas. As instruções passo a passo completas para aplicar rótulos de uso de dados a conjuntos de dados e campos podem ser encontradas no guia do usuário de rótulos DULE.

Pré-requisitos

Este guia exige uma compreensão prática dos seguintes componentes da Adobe Experience Platform:
  • Controle de dados: A estrutura pela qual a plataforma Experience aplica a conformidade de uso de dados.
    • Rótulos DULE: Os rótulos de uso de dados são aplicados aos campos de dados do Modelo de Dados de Experiência (XDM), especificando restrições para como esses dados podem ser acessados.
  • Sistema do Experience Data Model (XDM): A estrutura padronizada pela qual a plataforma Experience organiza os dados da 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 : A plataforma Experience fornece caixas de proteção virtuais que particionam uma única instância da Plataforma em ambientes virtuais separados para ajudar a desenvolver e desenvolver aplicativos de experiência digital.

Lendo chamadas de exemplo da API

Este guia 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 solução de problemas da plataforma Experience.

Reunir valores para cabeçalhos necessários

Para fazer chamadas para APIs de plataforma, você deve primeiro concluir 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 da API da plataforma da experiência, como mostrado abaixo:
  • Autorização: Portador {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Todos os recursos da plataforma Experience, incluindo os pertencentes ao Data Governance, estão isolados para caixas de proteção virtuais específicas. Todas as solicitações para APIs de plataforma exigem um cabeçalho que especifique o nome da caixa de proteção em que a operação ocorrerá:
  • x-sandbox-name: {SANDBOX_NAME}
Para obter mais informações sobre caixas de proteção na Plataforma, consulte a documentação de visão geral da caixa de proteção.
Todas as solicitações que contêm uma carga (POST, PUT, PATCH) exigem um cabeçalho adicional:
  • Tipo de conteúdo: application/json

Recursos principais vs. personalizados

Na API do Serviço de Política, todas as políticas e ações de marketing são referidas como core custom recursos ou recursos.
Os core recursos são definidos e mantidos pela Adobe, enquanto custom os recursos são criados e mantidos por clientes individuais e, portanto, são exclusivos e visíveis apenas para a organização IMS que os criou. 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 , PATCH e DELETE ) estão disponíveis para custom recursos.

Status da política

As políticas de uso de dados podem ter um de três status possíveis: DRAFT , ENABLED ou DISABLED .
Por padrão, somente as políticas "ATIVADAS" participam da avaliação de políticas.
As políticas "RASCUNHO" também podem ser consideradas na avaliação das políticas, mas apenas através da definição do parâmetro "query" ?includeDraft=true . Na seção documento sobre a aplicação das políticas, pode obter - se mais informações sobre a avaliação das políticas no final deste documento.

Nomes de ação de marketing

Nomes de ações de marketing são identificadores exclusivos para ações de marketing. Cada ação core de marketing tem um nome exclusivo que se aplica a todas as Organizações IMS. Esses nomes são definidos e mantidos pela Adobe. Enquanto isso, todas as ações de marketing definidas pelo cliente ( custom recursos) são exclusivas em sua organização individual e não são visíveis nem compartilhadas com outras Organizações IMS.
As etapas para trabalhar com ações de marketing na API do Serviço de Política são descritas na seção Ações de marketing posteriormente neste documento.

Próximas etapas

Agora que você tem o conhecimento e as credenciais pré-requisito, pode continuar a ler as chamadas de API de amostra fornecidas neste guia do desenvolvedor: