DocumentaçãoAdobe PassAdobe Pass Authentication

Iniciar autorização initiate-authorization

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:
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

Obtém a resposta de autorização.

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

ou

Serviço de Programador
1. solicitante (obrigatório)
2. deviceId (Obrigatório)
3. recurso (obrigatório)
4. device_info/X-Device-Info (Obrigatório)
5. deviceType
6. deviceUser (Obsoleto)
7. appId (obsoleto)
8. parâmetros extras (opcional)
GET
XML ou JSON que contém detalhes de autorização ou detalhes de erro, se malsucedido. Consulte os exemplos abaixo.
200 - Êxito
403 - Sem Êxito
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.
recurso
Uma cadeia de caracteres que contém um resourceId (ou fragmento MRSS), identifica o conteúdo solicitado por 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 para, por exemplo, Roku, Apple TV, Xbox etc.

Consulte Vantagens do parâmetro de tipo de dispositivo sem cliente em métricas de passagem

Observaçã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.
parâmetros extras
A chamada também pode conter parâmetros opcionais que habilitam outras funcionalidades como:

* generic_data - habilita o uso de Promotional TempPass

Exemplo: generic_data=("email":"email@domain.com")
CAUTION
Endereço IP do Dispositivo de Streaming

Para implementações de Cliente para servidor, o Endereço IP do dispositivo de transmissão é implicitamente enviado com esta chamada. Para implementações de Servidor para Servidor, em que a chamada regcode é feita pelo Serviço do Programador e não pelo Dispositivo de Streaming, o seguinte cabeçalho é necessário para passar o Endereço IP do Dispositivo de Streaming:
code language-none 
X-Forwarded-For : <streaming\_device\_ip>
onde <streaming\_device\_ip> é o endereço IP público do Dispositivo de Streaming.


Exemplo:
code language-none 
POST /reggie/v1/{req_id}/regcode HTTP/1.1
X-Forwarded-For:203.45.101.20

Exemplo de resposta sample-response

  • Caso 1: Sucesso

    • XML:

    "XML
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <authorization>
    <expires>1348148289000</expires>
    <mvpd>sampleMvpdId</mvpd>
    <requestor>sampleRequestorId</requestor>
    <resource>sampleResourceId</requestor>
    </authorization>
    "

  • JSON:

    code language-json 
    {
  "mvpd": "sampleMvpdId",
  "resource": "sampleResourceId",
  "requestor": "sampleRequestorId",
  "expires": "1348148289000"
}
IMPORTANT
Quando a resposta vem de um MVPD de Proxy, ela pode incluir um elemento adicional chamado proxyMvpd.

  • Caso 2: autorização negada

    code language-json 
    <error>
  <status>403</status>
  <message>User not authorized</message>
  <details>Your subscription package does not include the "ASFAFD" channel.
  Please go to http://www.ca.ble/upgrade in order to upgrade your subscription.</details>
</error>
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b