Search docs/

Layers Portal SDK

A funcionalidade de Portais da Layers permite que apps adicionem telas personalizadas à nossa interface, formando uma experiência unificada e integrando totalmente no ecossistema Layers.

Importando e configurando o SDK

Uma vez que o app está registrado ele poderá ser instalado nas comunidades e utilizado pelos usuários da comunidade em específico. Para que tudo funcione de forma segura e fluida para o usuário final, a página que será acessada através da Layers deve importar nosso SDK de portais da maneira que está exemplificado abaixo. Através desse SDK, apps podem acessar informações e funcionalidades da Layers.

<!DOCTYPE HTML>
<html>
  <head>
    <script>
      window.LayersPortalOptions = {
        appId: String,
        insidePortalOnly: Boolean,
        manualLoadingControl: Boolean
      }
    </script>
    <script type="text/javascript" src="https://js.layers.digital/v1/LayersPortal.js"></script>
  </head>
</html>
CopiarCopiado

Configurações do portal

O objeto LayersPortalOptions deve ser definido com as seguintes propriedades:

  • appId: String contendo o identificador do app
  • insidePortalOnly: Booleano indicando se a página deve ser acessível apenas através da Layers
  • manualLoadingControl: Booleano indicando se o app controlará o carregamento manualmente, chamando o método LayersPortal.ready() quando a página estiver carregada ou se o controle de carregamento deve ser feito automáticamente pela Layers

Utilizando o SDK

O SDK de portais disponibiliza uma série de eventos e promises para que apps que usam a funcionalidade de portais possam monitorar o status do SDK e da sua conexão com a Layers.

Eventos

  • ready: O evento ready é emitido quando o SDK de portais é carregado, indicando que ele foi importado com sucesso.
LayersPortal.on('ready', function(){
  //função chamada quando o SDK for carregado
})
CopiarCopiado
  • connected: O evento connected é emitido quando o SDK de portais está conectado com a Layers, indicando que apps podem acessar propriedades e métodos do SDK. A função chamada quando receber esse evento pode receber o objeto data com informações de usuário e seção como parâmetro.
LayersPortal.on('connected', function(data){
  //função chamada quando o SDK estiver conectado com a Layers
})
CopiarCopiado

Promises

Além dos eventos, apps podem optar por usar promises para controlar o status do SDK.

  • readyPromise: A propriedade readyPromise é, como o nome sugere, uma promise que será resolvida quando o SDK for importado com sucesso.

  • connectedPromise: Assim como a propriedade anterior, a propriedade connectedPromise será resolvida quando o SDK estiver conectado com a Layers retornando as informações de seção e do usuário acessando o portal.

O SDK de portais também oferece propriedades e métodos que permitem que apps acessem informações não sensíveis do usuário acessando o portal e funcionalidades de navegação Layers

Propriedades

  • ready: Booleano que indica se o SDK de portais foi importado com sucesso
  • connected: Booleano que indica se o SDK de portais está conectado com a Layers
  • platform: String que pode ter o valor de "iframe", "ios" ou "android" se a página estiver sendo acessada através da Layers ou null se estiver sendo acessada fora da Layers.
  • session: String da seção
  • userId: String do identificador único do usuário na Layers
  • communityId: String do identificador da comunidade através do qual o usuário está acessando o portal
  • accountId: String do identificador único da conta do usuário acessando o portal

Métodos

  • ready: O método ready() deve ser chamado para indicar que a página a ser exposta no portal está carregada se a a opção manualLoadingControl for definida como true nas configurações do portal.
  • update: O método update(params) permite que apps atualizem a URL e/ou o título do portal. Para isso, o app deve chamar a função como mostrado no exemplo abaixo:
LayersPortal.update(
  {
    url: String, //nova URL (opcional)
    title: String //novo título (opcional)
  }
)
CopiarCopiado
  • go: O método go(path) permite que portais redirecionem para outras páginas de portais ou da Layers. Para isso, o app deve chamar a função passando como parâmetro a URL da página para a qual o usuário deve ser redirecionado.
  • close: O método close() permite que o app feche o portal

Autenticação

A autenticação pode ser feita através do uso das informações no SDK de portais e da rota de validar sessão. Essa rota recebe nos parâmetros da query a session, o userId e a community. Fora isso, a rota também necessita da utilização de um token de aplicação, que é fornecido pela Layers à Startup durante o processo de integração. As informações necessárias podem ser extraídas do SDK de portais da seguinte maneira:

const { session, communityId, userId } = LayersPortal
CopiarCopiado

Assim, a aplicação pode fazer uma requisição na URL de validação de sessão no seguinte formato:

Authorization: Bearer {{AppToken}}
CopiarCopiado
GET https://api.layers.digital/v1/sso/session/validate?session={SESSION}&community={COMMUNITY}&userId={USER_ID}
CopiarCopiado

Caso as informações enviadas sejam válidas, a rota de validação de sessão responderá com status 200 confirmando que essa é uma sessão válida e o usuário está autenticado na Layers.

Anterior
Portais na Layers
Próximo
Single Sign-On na Layers