DocumentaçãoAdobe PassAdobe Pass Authentication

Fluxo de autenticação básico executado no aplicativo secundário

Última atualização: 5 de março de 2025
  • Tópicos:
  • Authentication
IMPORTANT
O conteúdo desta página é fornecido apenas para fins informativos. O uso desta API requer uma licença atual da Adobe. Não é permitida nenhuma utilização não autorizada.
IMPORTANT
A implementação da REST API V2 é limitada pela documentação do Mecanismo de limitação.
Related Articles
Visite também as Perguntas frequentes sobre a REST API V2.

O Fluxo de autenticação dentro do direito de Autenticação Adobe Pass permite que o aplicativo de streaming verifique se um usuário tem uma conta válida do MVPD. Esse processo exige que o usuário tenha uma conta ativa do MVPD e insira credenciais de logon válidas na página de logon do MVPD.

O fluxo de autenticação é necessário nos seguintes casos:

  • Quando o usuário abre um aplicativo pela primeira vez.
  • Quando a autenticação anterior do usuário expirar.
  • Quando o usuário faz logoff da conta do MVPD.
  • Quando o usuário deseja autenticar com uma MVPD diferente.

Em todos esses casos, o aplicativo que chama qualquer um dos endpoints de Perfis recebe uma resposta vazia para um ou mais perfis, mas para MVPDs diferentes.

O Fluxo de autenticação requer que um agente do usuário (navegador) conclua uma série de chamadas do aplicativo para o back-end do Adobe Pass, depois para a página de logon do MVPD e, por fim, de volta para o aplicativo. Esse fluxo pode incluir vários redirecionamentos para sistemas MVPD e gerenciamento de cookies ou sessões armazenados para cada domínio, o que pode ser desafiador de alcançar e proteger sem um agente do usuário.

Com base nos recursos do aplicativo principal (aplicativo de transmissão) para oferecer suporte à interação do usuário para selecionar uma MVPD e autenticar com o MVPD selecionado em um agente do usuário, os cenários de autenticação são:

  • Executar autenticação no aplicativo principal
  • Realizar autenticação no aplicativo secundário com mvpd pré-selecionado
  • Executar autenticação no aplicativo secundário sem mvpd pré-selecionado

Realizar autenticação no aplicativo secundário com mvpd pré-selecionado

Pré-requisitos

Antes de iniciar o fluxo de autenticação em um aplicativo principal e finalizá-lo por meio da interação do usuário em um aplicativo secundário, verifique se os seguintes pré-requisitos foram atendidos:

  • O aplicativo de streaming deve selecionar uma MVPD.
  • O aplicativo de streaming deve iniciar uma sessão de autenticação para entrar com o MVPD selecionado.
  • O aplicativo secundário deve ser autenticado com o MVPD selecionado em um agente do usuário.
IMPORTANT
Suposições
  • O aplicativo de streaming é compatível com a interação do usuário para selecionar uma MVPD.
  • O aplicativo secundário (geralmente em um dispositivo secundário) oferece suporte à interação do usuário para autenticação com o MVPD selecionado em um agente do usuário.

Fluxo de trabalho (WRK)

Siga as etapas fornecidas para implementar o fluxo de autenticação básico executado em um aplicativo secundário com um MVPD pré-selecionado, conforme mostrado no diagrama a seguir.

Executar autenticação no aplicativo secundário com mvpd pré-selecionado

Executar autenticação no aplicativo secundário com mvpd pré-selecionado

  1. Criar sessão de autenticação: o aplicativo de streaming reúne todos os dados necessários para iniciar uma sessão de autenticação chamando o ponto de extremidade Sessões.

    IMPORTANT
    Consulte a documentação da API Criar sessão de autenticação para obter detalhes sobre:
    • Todos os parâmetros necessários, como serviceProvider, mvpd, domainName e redirectUrl
    • Todos os cabeçalhos necessários, como Authorization, AP-Device-Identifier
    • Todos os parâmetros e cabeçalhos opcionais
    O aplicativo de streaming deve fornecer todos os parâmetros necessários em uma única chamada ao criar a sessão de autenticação.

  2. Indique a próxima ação: A resposta do ponto de extremidade Sessions contém os dados necessários para orientar o aplicativo de streaming em relação à próxima ação.

    IMPORTANT
    Consulte a documentação da API Criar sessão de autenticação para obter detalhes sobre as informações fornecidas na resposta da sessão.
    O endpoint de Sessões valida os dados da solicitação para garantir que as condições básicas sejam atendidas:
    • Os parâmetros e cabeçalhos requeridos devem ser válidos.
    • A integração entre o serviceProvider e o mvpd fornecidos deve estar ativa.
    Se a validação falhar, uma resposta de erro será gerada, fornecendo informações adicionais que seguem a documentação de Códigos de erro aprimorados.

  3. Continuar com fluxos de decisões: A resposta do ponto de extremidade Sessões contém os seguintes dados:

    • O atributo actionName está definido como "autorize".
    • O atributo actionType está definido como "direto".

    Se o back-end do Adobe Pass identificar um perfil válido, o aplicativo de transmissão não precisará reautenticar com o MVPD selecionado, pois já há um perfil que pode ser usado para fluxos de decisões subsequentes.

  4. Exibir código de autenticação: A resposta do ponto de extremidade Sessions contém os seguintes dados:

    • O code que pode ser usado para retomar a sessão de autenticação em um aplicativo secundário.
    • O atributo actionName está definido como "autenticar".
    • O atributo actionType está definido como "interativo".

    Se o back-end do Adobe Pass não identificar um perfil válido, o aplicativo de streaming exibirá o code que pode ser usado para retomar a sessão de autenticação em um aplicativo secundário.

  5. Validar código de autenticação: o aplicativo secundário valida o usuário fornecido code para garantir que ele possa continuar com a autenticação MVPD no agente do usuário.

    IMPORTANT
    Consulte a Documentação da API Recuperar informações da sessão de autenticação para obter detalhes sobre:
    • Todos os parâmetros necessários, como serviceProvider e code
    • Todos os cabeçalhos necessários, como Authorization
    • Todos os parâmetros e cabeçalhos opcionais

  6. Retornar informações sobre a sessão de autenticação: A resposta do ponto de extremidade Sessions contém os seguintes dados:

    • O atributo existing contém os parâmetros existentes que já foram fornecidos.
    • O atributo missing contém os parâmetros ausentes que precisam ser fornecidos para concluir o fluxo de autenticação.
    IMPORTANT
    Consulte a documentação da API Recuperar informações da sessão de autenticação para obter detalhes sobre as informações fornecidas em uma resposta de validação de sessão.
    O endpoint de Sessões valida os dados da solicitação para garantir que as condições básicas sejam atendidas:
    • Os parâmetros e cabeçalhos requeridos devem ser válidos.
    Se a validação falhar, uma resposta de erro será gerada, fornecendo informações adicionais que seguem a documentação de Códigos de erro aprimorados.
    TIP
    Sugestão: O aplicativo secundário pode informar os usuários que o code usado é inválido no caso de uma resposta de erro indicando uma sessão de autenticação ausente, e aconselhá-los a tentar novamente usando um novo.

  7. Abrir URL no agente do usuário: o aplicativo secundário abre um agente do usuário para carregar o url autocomputado, fazendo uma solicitação ao ponto de extremidade de Autenticação. Esse fluxo pode incluir vários redirecionamentos, levando o usuário à página de logon do MVPD e fornecendo credenciais válidas.

    IMPORTANT
    Consulte a Executar autenticação na documentação da API do agente do usuário para obter detalhes sobre:
    • Todos os parâmetros necessários, como serviceProvider e code
    • Todos os parâmetros e cabeçalhos opcionais

  8. Concluir autenticação do MVPD: Se o fluxo de autenticação for bem-sucedido, a interação do agente do usuário salvará um perfil regular no back-end do Adobe Pass e alcançará o redirectUrl fornecido.

  9. Recuperar perfil para código específico: O aplicativo de streaming reúne todos os dados necessários para recuperar informações de perfil, enviando uma solicitação ao ponto de extremidade de Perfis.

    IMPORTANT
    Consulte a documentação da API Recuperar perfil para código específico para obter detalhes sobre:
    • Todos os parâmetros necessários, como serviceProvider e code
    • Todos os cabeçalhos necessários, como Authorization, AP-Device-Identifier
    • Todos os parâmetros e cabeçalhos opcionais
    TIP
    Sugestão: O aplicativo de streaming pode implementar um mecanismo de sondagem usando o code para verificar se o perfil regular foi gerado e salvo com êxito.

  10. Retornar informações sobre o perfil regular: A resposta do ponto de extremidade Perfis contém informações sobre o perfil regular associado aos parâmetros e cabeçalhos recebidos.

    IMPORTANT
    Consulte a documentação da API Recuperar perfil para código específico para obter detalhes sobre as informações fornecidas em uma resposta de perfil.
    O endpoint de Perfis valida os dados da solicitação para garantir que as condições básicas sejam atendidas:
    • Os parâmetros e cabeçalhos requeridos devem ser válidos.
    Se a validação falhar, uma resposta de erro será gerada, fornecendo informações adicionais que seguem a documentação de Códigos de erro aprimorados.

Executar autenticação no aplicativo secundário sem mvpd pré-selecionado

Pré-requisitos

Antes de iniciar o fluxo de autenticação em um aplicativo principal e finalizá-lo por meio da interação do usuário em um aplicativo secundário, verifique se os seguintes pré-requisitos foram atendidos:

  • O aplicativo de streaming deve iniciar uma sessão de autenticação quando precisar entrar.
  • O aplicativo secundário deve selecionar uma MVPD.
  • O aplicativo secundário deve ser autenticado com o MVPD selecionado em um agente do usuário.
IMPORTANT
Suposições
  • O aplicativo secundário (geralmente em um dispositivo secundário) é compatível com a interação do usuário para selecionar uma MVPD.
  • O aplicativo secundário (geralmente em um dispositivo secundário) oferece suporte à interação do usuário para autenticação com o MVPD selecionado em um agente do usuário.

Fluxo de trabalho (WRK)

Siga as etapas fornecidas para implementar o fluxo de autenticação básico executado em um aplicativo secundário sem um MVPD pré-selecionado, conforme mostrado no diagrama a seguir.

Executar autenticação no aplicativo secundário sem mvpd pré-selecionado

Executar autenticação no aplicativo secundário sem mvpd pré-selecionado

  1. Criar sessão de autenticação: o aplicativo de streaming reúne alguns dos dados necessários para iniciar uma sessão de autenticação chamando o ponto de extremidade Sessões.

    IMPORTANT
    Consulte a documentação da API Criar sessão de autenticação para obter detalhes sobre:
    • Todos os parâmetros necessários, como serviceProvider
    • Todos os cabeçalhos necessários, como Authorization, AP-Device-Identifier
    • Todos os parâmetros e cabeçalhos opcionais
    O aplicativo de streaming não pode fornecer todos os parâmetros necessários em uma única chamada ao criar a sessão de autenticação.

  2. Indique a próxima ação: A resposta do ponto de extremidade Sessions contém os dados necessários para orientar o aplicativo de streaming em relação à próxima ação:

    • O code que pode ser usado para retomar a sessão de autenticação em um aplicativo secundário.
    • O atributo actionName está definido como "retomar".
    • O atributo actionType está definido como "direto".
    IMPORTANT
    Consulte a documentação da API Criar sessão de autenticação para obter detalhes sobre as informações fornecidas na resposta da sessão.
    O endpoint de Sessões valida os dados da solicitação para garantir que as condições básicas sejam atendidas:
    • Os parâmetros e cabeçalhos requeridos devem ser válidos.
    Se a validação falhar, uma resposta de erro será gerada, fornecendo informações adicionais que seguem a documentação de Códigos de erro aprimorados.

  3. Exibir código de autenticação: o aplicativo de streaming exibe o code que pode ser usado para retomar a sessão de autenticação em um aplicativo secundário.

  4. Fornecer parâmetros ausentes da sessão de autenticação: O aplicativo secundário reúne todos os dados ausentes necessários para retomar a sessão de autenticação e chama o ponto de extremidade Sessões.

    IMPORTANT
    Consulte a documentação da API Retomar sessão de autenticação para obter detalhes sobre:
    • Todos os parâmetros necessários, como serviceProvider, mvpd, domainName e redirectUrl
    • Todos os cabeçalhos necessários, como Authorization, AP-Device-Identifier
    • Todos os parâmetros e cabeçalhos opcionais

  5. Indique a próxima ação: A resposta do ponto de extremidade Sessions contém os dados necessários para orientar o aplicativo de streaming em relação à próxima ação.

    IMPORTANT
    Consulte a documentação da API Retomar sessão de autenticação para obter detalhes sobre as informações fornecidas na resposta da sessão.
    O endpoint de Sessões valida os dados da solicitação para garantir que as condições básicas sejam atendidas:
    • Os parâmetros e cabeçalhos requeridos devem ser válidos.
    • A integração entre o serviceProvider e o mvpd fornecidos deve estar ativa.
    Se a validação falhar, uma resposta de erro será gerada, fornecendo informações adicionais que seguem a documentação de Códigos de erro aprimorados.
    TIP
    Sugestão: O aplicativo secundário pode informar os usuários que o code usado é inválido no caso de uma resposta de erro indicando uma sessão de autenticação ausente, e aconselhá-los a tentar novamente usando um novo.

  6. Indicar perfil existente: A resposta do ponto de extremidade Sessions contém os seguintes dados:

    • O atributo actionName está definido como "autorize".
    • O atributo actionType está definido como "direto".

    Se o back-end do Adobe Pass identificar um perfil válido, o aplicativo de transmissão não precisará reautenticar com o MVPD selecionado, pois já há um perfil que pode ser usado para fluxos de decisões subsequentes.

  7. Abrir URL no agente do usuário: A resposta do ponto de extremidade Sessões contém os seguintes dados:

    • O url que pode ser usado para iniciar a autenticação interativa na página de logon do MVPD.
    • O atributo actionName está definido como "autenticar".
    • O atributo actionType está definido como "interativo".

    Se o back-end do Adobe Pass não identificar um perfil válido, o aplicativo secundário abrirá um agente do usuário para carregar o url fornecido, fazendo uma solicitação ao endpoint de Autenticação. Esse fluxo pode incluir vários redirecionamentos, levando o usuário à página de logon do MVPD e fornecendo credenciais válidas.

  8. Concluir autenticação do MVPD: Se o fluxo de autenticação for bem-sucedido, a interação do agente do usuário salvará um perfil regular no back-end do Adobe Pass e atingirá o redirectUrl fornecido.

  9. Recuperar perfil para código específico: O aplicativo de streaming reúne todos os dados necessários para recuperar informações de perfil, enviando uma solicitação ao ponto de extremidade de Perfis.

    IMPORTANT
    Consulte a documentação da API Recuperar perfil para código específico para obter detalhes sobre:
    • Todos os parâmetros necessários, como serviceProvider e code
    • Todos os cabeçalhos necessários, como Authorization, AP-Device-Identifier
    • Todos os parâmetros e cabeçalhos opcionais
    TIP
    Sugestão: O aplicativo de streaming pode implementar um mecanismo de sondagem usando o code para verificar se o perfil regular foi gerado e salvo com êxito.

  10. Retornar informações sobre o perfil regular: A resposta do ponto de extremidade Perfis contém informações sobre o perfil regular associado aos parâmetros e cabeçalhos recebidos.

    IMPORTANT
    Consulte a documentação da API Recuperar perfil para código específico para obter detalhes sobre as informações fornecidas em uma resposta de perfil.
    O endpoint de Perfis valida os dados da solicitação para garantir que as condições básicas sejam atendidas:
    • Os parâmetros e cabeçalhos requeridos devem ser válidos.
    Se a validação falhar, uma resposta de erro será gerada, fornecendo informações adicionais que seguem a documentação de Códigos de erro aprimorados.
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b