Guia do SDK do iOS/tvOS iostvos-sdk-cookbook

Crie suas funções de retorno de chamada:

• setRequestorComplete()

• Acionado por setRequestor(), retorna êxito ou falha.

• Success indica que você pode continuar com chamadas de direito.

• displayProviderDialog(mvpds)

  • Disparado por getAuthentication() somente se o usuário não tiver selecionado um provedor (MVPD) e ainda não estiver autenticado.
  • O parâmetro mvpds é uma matriz de provedores disponíveis para o usuário.

• setAuthenticationStatus(status, errorcode)

  • Disparado por checkAuthentication() toda vez.
  • Disparado por getAuthentication() somente se o usuário já estiver autenticado e tiver selecionado um provedor.
  • O status retornado é sucesso ou falha, o código de erro descreve o tipo da falha.

• navigateToUrl(url)

  • Disparado por getAuthentication() depois que o usuário seleciona um MVPD. O parâmetro url fornece o local da página de logon do MVPD.

• sendTrackingData(event, data)

  • Acionado por checkAuthentication(), getAuthentication(), checkAuthorization(), getAuthorization(), setSelectedProvider().
  • O parâmetro event indica qual evento de direito ocorreu; o parâmetro data é uma lista de valores relacionados ao evento.

• setToken(token, resource)

  • Acionado por checkAuthorization() e getAuthorization() após uma autorização bem-sucedida para exibir um recurso.
  • O parâmetro token é o token de mídia de vida curta; o parâmetro resource é o conteúdo que o usuário está autorizado a exibir.

• tokenRequestFailed(resource, code, description)

  • Acionado por checkAuthorization() e getAuthorization() após uma autorização malsucedida.
  • O parâmetro resource é o conteúdo que o usuário estava tentando exibir; o parâmetro code é o código de erro que indica que tipo de falha ocorreu; o parâmetro description descreve o erro associado ao código de erro.

• selectedProvider(mvpd)

  • Disparado por getSelectedProvider().
  • O parâmetro mvpd fornece informações sobre o provedor selecionado pelo usuário.

• setMetadataStatus(metadata, key, arguments)

  • Acionado por getMetadata().
  • O parâmetro metadata fornece os dados específicos solicitados; o parâmetro key é a chave usada na solicitação getMetadata(); e o parâmetro arguments é o mesmo dicionário passado para getMetadata().

• "preauthorizedResources(authorizedResources)"

  • Disparado por checkPreauthorizedResources().

  • O parâmetro authorizedResources apresenta os recursos que o usuário
    está autorizado a visualizar.

• "presentTvProviderDialog(viewController)"

  • Acionado por getAuthentication() quando o solicitante atual oferece suporte a pelo menos um MVPD que tem suporte para SSO.
  • O parâmetro viewController é a Caixa de Diálogo de SSO do Apple e precisa ser apresentado no controlador de exibição principal.

• "dismissTvProviderDialog(viewController)"

  • Acionado por uma ação do usuário (selecionando "Cancelar" ou "Outros provedores de TV" na caixa de diálogo SSO do Apple).
  • O parâmetro viewController é a Caixa de Diálogo de SSO do Apple e precisa ser descartado do controlador de exibição principal.

Iniciar o aplicativo de nível superior.

Iniciar Autenticação Adobe Pass

a. Chame init para criar uma única instância do Adobe Pass Authentication AccessEnabler.

• Dependência: Biblioteca iOS/tvOS Nativa de Autenticação do Adobe Pass (AccessEnabler)

b. Chame setRequestor() para estabelecer a identidade do Programador; transmita no requestorID do Programador e (opcionalmente) uma matriz de pontos de acesso de Autenticação do Adobe Pass. Para tvOS você também precisará fornecer a chave pública e o segredo. Consulte a Documentação sem clientes para obter mais detalhes.

• Dependência: RequestorID de Autenticação Adobe Pass Válida (Trabalhe com sua Conta de Autenticação Adobe Pass
  gerente para organizar isso).

• Acionadores:

  Retorno de chamada setRequestorComplete().

Você tem duas opções de implementação: uma vez que as informações de identificação do solicitante são enviadas ao servidor back-end, a camada de aplicativo da interface do usuário pode escolher uma das duas seguintes abordagens:

1. Aguarde o acionamento do retorno de chamada setRequestorComplete() (parte do delegado AccessEnabler). Essa opção fornece a maior certeza de que setRequestor() foi concluído, portanto, ela é recomendada para a maioria das implementações.

2. Continue sem aguardar o acionamento do retorno de chamada setRequestorComplete() e comece a emitir solicitações de direito. Essas chamadas (checkAuthentication, checkAuthorization, getAuthentication, getAuthorization, checkPreauthorizedResource, getMetadata, logout) são enfileiradas pela biblioteca AccessEnabler, que fará as chamadas de rede reais após setRequestor(). Ocasionalmente, essa opção pode ser interrompida se, por exemplo, a conexão de rede estiver instável.

Chame checkAuthentication() para verificar uma autenticação existente sem iniciar o fluxo de Autenticação completo. Se essa chamada for bem-sucedida, você poderá prosseguir diretamente para o Fluxo de autorização. Caso contrário, prossiga para o Fluxo de autenticação.

• Dependência: uma chamada bem-sucedida para setRequestor() (essa dependência também se aplica a todas as chamadas subsequentes).

• Triggers: retorno de chamada de setAuthenticationStatus().

Chame getAuthentication() para iniciar o fluxo de autenticação ou obter a confirmação de que o usuário já está
autenticado.

Acionadores:

• O retorno de chamada setAuthenticationStatus(), se o usuário já estiver autenticado. Nesse caso, prossiga diretamente para o Fluxo de Autorização.

• O retorno de chamada displayProviderDialog(), se o usuário ainda não estiver autenticado.

Apresentar ao usuário a lista de provedores enviada para
displayProviderDialog().

Depois que o usuário selecionar um provedor, obtenha a URL do MVPD do usuário do retorno de chamada navigateToUrl: ou navigateToUrl:useSVC: e abra um controlador UIWebView/WKWebView ou SFSafariViewController e direcione esse controlador para a URL.

Através do UIWebView/WKWebView ou SFSafariViewController instanciado na etapa anterior, o usuário acessa a página de logon do MVPD e insere credenciais de logon. Várias operações de redirecionamento ocorrem no controlador.

Após um logon bem-sucedido do usuário, a camada do aplicativo detecta o carregamento de um URL personalizado específico. Observe que esse URL personalizado específico é realmente inválido e não se destina ao controlador para carregá-lo. Ela deve ser interpretada somente pelo seu aplicativo como um sinal de que o fluxo de autenticação foi concluído e que é seguro fechar o controlador UIWebView/WKWebView ou SFSafariViewController. Caso seja necessário usar um controlador SFSafariViewController, a URL personalizada específica é definida pelo application's custom scheme (por exemplo, adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com); caso contrário, essa URL personalizada específica é definida pela constante ADOBEPASS_REDIRECT_URL (ou seja, adobepass://ios.app).

Feche o controlador UIWebView/WKWebView ou SFSafariViewController e chame o método de API handleExternalURL:url do AccessEnabler, que instrui o AccessEnabler a recuperar o token de autenticação do servidor back-end.

(Opcional) Chame checkPreauthorizedResources(resources) para verificar quais recursos o usuário está autorizado a visualizar. O parâmetro resources é uma matriz de recursos protegidos associada ao token de autenticação do usuário. Um uso das informações de autorização obtidas do MVPD do usuário é decorar sua interface do usuário (por exemplo, símbolos bloqueados/desbloqueados ao lado de conteúdo protegido).

• Acionadores: Retorno de chamada de preauthorizedResources()
• Ponto de execução: após a conclusão do fluxo de autenticação

Se a autenticação tiver sido bem-sucedida, prossiga para o Fluxo de autorização.

Chame getAuthentication() para iniciar o fluxo de autenticação ou obter a confirmação de que o usuário já está autenticado.
Acionadores:

• O retorno de chamada presentTvProviderDialog(), se o usuário não estiver autenticado e o solicitante atual tiver pelo menos um MVPD compatível com SSO. Se nenhum MVPD suportar SSO, o fluxo de autenticação clássico será usado.

Depois que o usuário seleciona um provedor, a biblioteca AccessEnabler obtém um token de autenticação com as informações fornecidas pela estrutura VSA da Apple.

O retorno de chamada setAuthenticationStatus() será disparado. Nesse ponto, o usuário deve ser autenticado com o Apple SSO.

[Opcional] Chame checkPreauthorizedResources(resources) para verificar quais recursos o usuário está autorizado a visualizar. O parâmetro resources é uma matriz de recursos protegidos associada ao token de autenticação do usuário. Um uso das informações de autorização obtidas do MVPD do usuário é decorar sua interface do usuário (por exemplo, símbolos bloqueados/desbloqueados ao lado de conteúdo protegido).

• Acionadores: Retorno de chamada de preauthorizedResources()
• Ponto de execução: após a conclusão do fluxo de autenticação

Se a autenticação tiver sido bem-sucedida, prossiga para o Fluxo de autorização.

Ligue para getAuthentication() para iniciar o
fluxo de autenticação ou para obter a confirmação de que o usuário já está
autenticado.
Acionadores:

• O retorno de chamada presentTvProviderDialog(), se o usuário não estiver autenticado e o solicitante atual tiver pelo menos um MVPD compatível com SSO. Se nenhum MVPD suportar SSO, o fluxo de autenticação clássico será usado.

Depois que o usuário selecionar um provedor, o retorno de chamada status() será chamado. Um código de registro será fornecido e a biblioteca AccessEnabler iniciará a sondagem do servidor para uma segunda autenticação de tela bem-sucedida.

Se o código de registro fornecido tiver sido usado para autenticação com êxito na segunda tela, o retorno de chamada setAuthenticatiosStatus() será acionado. Nesse ponto, o usuário deve ser autenticado com o Apple SSO.

[Opcional] Chame checkPreauthorizedResources(resources) para verificar quais recursos o usuário está autorizado a visualizar. O parâmetro resources é uma matriz de recursos protegidos associada ao token de autenticação do usuário. Um uso das informações de autorização obtidas do MVPD do usuário é decorar sua interface do usuário (por exemplo, símbolos bloqueados/desbloqueados ao lado de conteúdo protegido).

• Acionadores: Retorno de chamada de preauthorizedResources()

• Ponto de execução: após a conclusão do fluxo de autenticação

Se a autenticação tiver sido bem-sucedida, prossiga para o Fluxo de autorização.

Chame getAuthorization() para iniciar o fluxo de autorização.

• Dependência: ResourceID(s) válido(s) acordado(s) com o(s) MVPD(s).
• As IDs de recursos devem ser as mesmas usadas em quaisquer outros dispositivos ou plataformas e serão as mesmas em todos os MVPDs. Para obter informações sobre IDs de Recursos, consulte Identificando Recursos Protegidos

Validar autenticação e autorização.

• Se a chamada getAuthorization() tiver êxito: o usuário tem tokens AuthN e AuthZ válidos (o usuário é autenticado e autorizado a assistir à mídia solicitada).

• Se getAuthorization() falhar: examine a exceção lançada para determinar seu tipo (AuthN, AuthZ ou algo mais):

  • Se foi um erro de autenticação (AuthN), reinicie o fluxo de autenticação.
  • Se foi um erro de autorização (AuthZ), o usuário não está autorizado a assistir à mídia solicitada, e algum tipo de mensagem de erro deve ser exibido para o usuário.
  • Se houver algum outro tipo de erro (erro de conexão, erro de rede etc.) em seguida, exiba uma mensagem de erro apropriada para o usuário.

Valide o token de mídia curta.
Use a biblioteca do Verificador de Token de Mídia de Autenticação do Adobe Pass para verificar o token de mídia de vida curta retornado da chamada getAuthorization() acima:

• Se a validação for bem-sucedida: Reproduza a mídia solicitada para o usuário.
• Se a validação falhar: O token AuthZ era inválido, a solicitação de mídia deve ser recusada e uma mensagem de erro deve ser exibida ao usuário.

Retorne ao fluxo normal do aplicativo.

O usuário seleciona a mídia a ser exibida.

A mídia está protegida? Seu aplicativo verifica se a mídia selecionada está protegida:

• Se a mídia selecionada estiver protegida, o aplicativo iniciará o Fluxo de Autorização acima.

• Se a mídia selecionada não estiver protegida, reproduzir a mídia por
  o usuário.

Ligue para logout() para desconectar o usuário. O AccessEnabler apaga todos os valores e tokens em cache. Depois de limpar o cache, o AccessEnabler faz uma chamada de servidor para limpar as sessões do lado do servidor. Como a chamada do servidor pode resultar em um redirecionamento SAML para o IdP (isso permite a limpeza da sessão no lado do IdP), essa chamada deve seguir todos os redirecionamentos. Por esse motivo, essa chamada deve ser tratada em um controlador UIWebView/WKWebView ou SFSafariViewController.

a. Seguindo o mesmo padrão do fluxo de trabalho de autenticação, o domínio AccessEnabler faz uma solicitação à camada de aplicativo da interface do usuário, por meio do retorno de chamada navigateToUrl: ou navigateToUrl:useSVC:, para criar um controlador UIWebView/WKWebView ou SFSafariViewController e instruir esse controlador a carregar a URL fornecida no parâmetro url do retorno de chamada. Este é o URL do ponto de extremidade de logout no servidor back-end.

b. Seu aplicativo deve monitorar a atividade do controlador UIWebView/WKWebView or SFSafariViewController e detectar o momento em que carrega um URL personalizado específico, conforme passa por vários redirecionamentos. Observe que esse URL personalizado específico é realmente inválido e não se destina ao controlador para carregá-lo. Ela deve ser interpretada somente pelo seu aplicativo como um sinal de que o fluxo de logout foi concluído e que é seguro fechar o controlador UIWebView/WKWebView ou SFSafariViewController. Quando o controlador carrega esta URL personalizada específica, seu aplicativo deve fechar o controlador UIWebView/WKWebView or SFSafariViewController e chamar o método de API handleExternalURL:url do AccessEnabler. Caso seja necessário usar um controlador SFSafariViewController, a URL personalizada específica é definida pelo application's custom scheme (por exemplo, adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com), caso contrário, essa URL personalizada específica é definida pela constante ADOBEPASS_REDIRECT_URL (ou seja, adobepass://ios.app).