DocumentaçãoAdobe PassAdobe Pass Authentication

Metadados do usuário user-metadata

Last update: Wed Mar 13 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
O conteúdo desta página é fornecido apenas para fins informativos. O uso desta API requer uma licença atual do Adobe. Não é permitida nenhuma utilização não autorizada.
NOTE
A implementação da REST API é limitada por Mecanismo de limitação

Endpoints da REST API clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

Descrição description

Recupere os metadados que o MVPD compartilhou sobre o usuário autenticado.

Endpoint
Chamado
Por
Entrada
Params
HTTP
Método
Resposta
HTTP
Resposta
<SP_FQDN>/api/v1/tokens/usermetadata
Aplicativo de transmissão

ou

Serviço de programador
1. requerente
2. deviceId (Obrigatório)
3. device_info/X-Device-Info (Obrigatório)
4. deviceType
5. deviceUser (obsoleto)
6. appId (obsoleto)
GET
XML ou JSON que contém metadados do usuário ou detalhes do erro, se malsucedido.

200 - Sucesso

404 - Nenhum metadado encontrado

412 - Token de autenticação inválido (por exemplo, token expirado)

Parâmetro de entrada
Descrição
solicitante
O requestorId do Programador para o qual esta operação é válida.
deviceId
Os bytes de id do dispositivo.

device_info/

X-Device-Info

Informações do dispositivo de transmissão.

Nota: Isso PODE ser passado para device_info como um parâmetro de URL, mas devido ao tamanho potencial desse parâmetro e limitações no comprimento de um URL GET, ele DEVE ser passado como X-Device-Info no cabeçalho http.

Veja todos os detalhes em Transmitindo Informações sobre Dispositivo e Conexão.
deviceType
O tipo de dispositivo (por exemplo, Roku, PC).

Se esse parâmetro estiver definido corretamente, o ESM oferecerá métricas que são detalhado por tipo de dispositivo ao usar sem cliente, para que diferentes tipos de análise possam ser executados para, por exemplo, Roku, Apple TV, Xbox etc.

Consulte Benefícios do uso do parâmetro do tipo de dispositivo sem cliente nas métricas de Passagem

Nota: A variável device_info O substitui esse parâmetro.
deviceUser
O identificador do usuário do dispositivo.

Nota: Se usado, deviceUser deve ter os mesmos valores que no Criar código de registro solicitação.
appId
O id/nome do aplicativo.

Nota: A variável device_info O substitui esse parâmetro. Se usado, appId deve ter os mesmos valores que no Criar código de registro solicitação.
NOTE
As informações de metadados do usuário devem estar disponíveis após a conclusão do fluxo de autenticação, mas podem ser atualizadas no fluxo de autorização, dependendo do MVPD e do tipo de metadados.

Exemplo de resposta sample-response

Após uma chamada bem-sucedida, o servidor responderá com um objeto XML (padrão) ou JSON com uma estrutura semelhante à apresentada abaixo:

    {
        updated: 1334243471,
        encrypted: ["encryptedProp"],
        data: {
              zip: ["12345", "34567"],
              maxRating: {
                  "MPAA": "PG-13",
                  "VCHIP": "TV-Y",
                  "URL": "http://exam.pl/e/manage/ratings"
                         },
              householdID: "3456",
              userID: "BgSdasfsdk23/dsaf3+saASesadgfsShggssd=",
              channelID: ["channel-1", "channel-2"]
              }
    }

Na raiz do objeto, haverá três nós:

  • atualizado: especifica um carimbo de data e hora UNIX que representa a última vez que os metadados foram atualizados. Essa propriedade será definida inicialmente pelo servidor ao gerar os metadados durante a fase de autenticação. Chamadas subsequentes (após a atualização dos metadados) resultarão em um carimbo de data e hora incrementado.
  • dados: contém os valores reais de metadados.
  • criptografado: uma matriz que lista as propriedades criptografadas. Para descriptografar um valor de metadados específico, o Programador deve executar uma decodificação Base64 nos metadados e, em seguida, aplicar uma descriptografia RSA no valor resultante, usando sua própria chave privada (o Adobe criptografa os metadados no servidor usando o certificado público do Programador).

No caso de um erro, o servidor retornará um objeto XML ou JSON que especifica uma mensagem de erro detalhada.

Para obter mais informações, consulte Metadados do usuário.

Voltar para Referência da API REST

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b