DocumentaçãoAdobe PassAdobe Pass Authentication

Recuperar lista de recursos pré-autorizados retrieve-list-of-preauthorized-resources

Last update: Thu Jul 18 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

Uma solicitação para que a Autenticação do Adobe Pass obtenha a lista de recursos pré-autorizados.

Há dois conjuntos de APIs: um conjunto para o Aplicativo de streaming ou Serviço de programador e um conjunto para o Aplicativo Web de segunda tela. Esta página descreve a API do aplicativo de streaming ou do serviço de programador.

Endpoint
Chamado
por
Entrada
Parâmetros
HTTP
Método
Resposta
Resposta HTTP
<SP_FQDN>/api/v1/preauthorize
Aplicativo de Streaming

ou

Serviço de Programador
1. solicitante (obrigatório)
2. deviceId (Obrigatório)
3. lista de recursos (Obrigatória)
4. device_info/X-Device-Info (Obrigatório)
5. deviceType
6. deviceUser (Obsoleto)
7. appId (obsoleto)
GET
XML ou JSON que contém decisões individuais de pré-autorização ou detalhes de erros. Consulte os exemplos abaixo.
200 - Êxito

400 - Solicitação inválida

401 - Não autorizado

405 - Método não permitido

412 - Falha na pré-condição

500 - Erro Interno do Servidor
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.
lista de recursos
Uma string que contém uma lista delimitada por vírgulas de resourceIds que identifica o conteúdo que pode ser acessível a um usuário e é reconhecida por pontos de extremidade de autorização MVPD.
device_info/

X-Device-Info
Informações do dispositivo de transmissão.

Observação: isso PODE ser passado para device_info como um parâmetro de URL, mas devido ao tamanho potencial desse parâmetro e às limitações no comprimento de uma URL GET, DEVE ser passado como X-Device-Info no cabeçalho http.

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

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

Veja, os benefícios de usar o parâmetro de tipo de dispositivo sem cliente nas métricas de passagem

Observação: o device_info substituirá esse parâmetro.
deviceUser
O identificador do usuário do dispositivo.
appId
O id/nome do aplicativo.

Observação: device_info substitui este parâmetro.

Exemplo de resposta sample-response

XML:

HTTP/1.1 200 OK
Adobe-Request-Id : 7af28ec2-a068-45c2-8009-f5443049baf4
Adobe-Response-Confidence : full
Content-Type: application/xml; charset=utf-8

<resources>
  <resource>
    <id>TestStream1</id>
    <authorized>true</authorized>
  </resource>
  <resource>
    <id>TestStream2</id>
    <authorized>false</authorized>
    <error>
      <status>403</status>
      <code>authorization_denied_by_mvpd</code>
      <message>User not authorized</message>
      <details>Your subscription package does not include the "TestStream3" channel.</details>
      <helpUrl>https://experienceleague-review.corp.adobe.com/docs/primetime/authentication/auth-features/error-reportn/enhanced-error-codes.html#error-codes</helpUrl>
      <trace>0453f8c8-167a-4429-8784-cd32cfeaee58</trace>
      <action>none</action>
    </error>
  </resource>
</resources>

JSON:

HTTP/1.1 200 OK
Adobe-Request-Id : 7af28ec2-a068-45c2-8009-f5443049baf4
Adobe-Response-Confidence : full
Content-Type: application/json; charset=utf-8

{
   "resources" : [
        {
            "id" : "TestStream1",
            "authorized" : true
        },
        {
            "id" : "TestStream3",
            "authorized" : false,
            "error" : {
               "status" : 403,
               "code" : "authorization_denied_by_mvpd",
               "message" : "User not authorized",
               "details" : "Your subscription package does not include the "TestStream3" channel.",
               "helpUrl" : "https://experienceleague-review.corp.adobe.com/docs/primetime/authentication/auth-features/error-reportn/enhanced-error-codes.html#error-codes",
               "trace" : "0453f8c8-167a-4429-8784-cd32cfeaee58",
               "action" : "none"
            }
        }
    ]
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b