Embutir funcionalidades de forma simples

Introdução:

O aplicativo possui uma variedade de serviços disponíveis para os usuários. Uma das funcionalidades oferecidas é a capacidade de incorporar determinadas funcionalidades do aplicativo em uma página da web externa. Esse recurso é conhecido como "embutir" e permite aos usuários aproveitar os recursos do aplicativo em seus próprios sites.

Objetivo

Este documento técnico tem como objetivo fornecer orientações sobre como utilizar o recurso de "embutir" em uma página da web. Ele explicará os passos necessários para obter o código de incorporação do aplicativo e como configurar corretamente a segurança para permitir o uso dessa funcionalidade em um domínio específico.

Passo 1

Obter o código de incorporação A primeira etapa é gerar o código de incorporação no aplicativo. Siga estas etapas para obtê-lo:

  • Acesse a funcionalidade de "embutir" no painel público, disponível em:

    • Configurador de funcionalidades → Botão Editar ou Visualizar (escolha um dos 2) → Visualize as propriedades da funcionalidade que deseja embutir → Localize a aba “Embutir”.

Acessando a funcionalidade > aba “embutir”
  • Será exibido um código JavaScript gerado automaticamente. Copie esse código para a área de transferência.

Copiando os códigos de integração

IMPORTANTE: Todos os trechos de código precisam ser utilizados na configuração da sua página. Ou seja, copie / cole os códigos 1, 2, 3 e 4. Sua aplicação não vai funcionar corretamente se deixar de copiar um ou mais desses códigos.

Passo 2

Configurar a segurança Para garantir que a funcionalidade de incorporação esteja disponível apenas em domínios autorizados, você precisa configurar a segurança adequada. Siga estas etapas para configurar as origens permitidas:

  • Acesse a seção "Segurança" do configurador públuico.

  • Localize a opção de "Cadastrar Origem" > “Nova Origem”

Incluindo nova origem

 

  • Insira o domínio da página da web onde você deseja permitir a incorporação. Certifique-se de digitar o domínio corretamente (por exemplo, dominioOperadora.com.br).

 

1- Selecione a opção na qual deseja liberar uma funcionalidade

2 - Selecione a funcionalidade desejada (ex: Rede Credenciada)

3 - Coloque uma descrição

4 - Coloque a Origem na qual a funcionalidade será renderizada (isso para permitir que no dominio da URL/IP informada a funcionalidade possa ser renderizada)

Informe os dados corretamente
  • Salve as alterações.

 

Passo 3

Adicionar o código de incorporação na página da web Agora que você tem o código de incorporação e configurou a segurança, pode adicionar o código à página da web desejada. Siga estas etapas:

  1. Abra o código HTML da página da web onde você deseja incorporar a funcionalidade.

  2. Localize a seção <head> do documento HTML.

  3. Cole o código de incorporação no local desejado dentro da tag <head>.

  4. Salve as alterações no arquivo HTML.

Exemplo de funcionalidade disponibilizada

ATENÇÃO
Em caso de testes em ambiente de sandbox é necessário passar o parâmetro “instanciaAplicacao” conforme exemplo abaixo:

<script src="https://omnichannel-sdk.mosiaomnichannel.com.br/"</script>>
<div id="container-ms-4-4"></div>
<script type="text/javascript">
let funcionalidadeS9 = window.omnichannelSDK.embed({
id: "container-ms-4-4",
url: "https://funcionalidades-front.mosiaomnichannel.com.br/",
json: {
idFuncionalidade: 4,
bundle: "HASH",
authorization: null, // opcional para funcionalidades que não necessitam de login
esquemaCor: null, // null pega o default, ou o slug de um esquema qualquer
instanciaAplicacao: 1
}
})
</script>

Particularidades do embed da Rede Credenciada

A funcionalidade de Rede Credenciada (ou Guia Médico), tem opções adicionais de configuração de Densidade. Essa opção é muito utilizada para possibilitar a busca da rede credenciada, como em um site ou área do beneficiário, sem ocupar muito espaço.

image-20250218-164936.png

Essas são as 3 densidades disponíveis, quanto maior, mais compacto.

Quando utilizado, o embed condensado, será preciso cadastrar uma segunda página, que receberá os resultados da busca realizada. Esta página OBRIGATORIAMENTE deve utilizar a versão completa do embed, e a URL que contém essa versão deve ser configurada, no parâmetro de funcionalidade chamado urlEmbedCompleto

image-20250218-165103.png
Embed Completo, obtido na aba embed da configuração da funcionalidade
image-20250218-165444.png
Parâmetro urlEmbedCompleto que deve ser editado
image-20250218-165309.png
Parâmetro da funcionalidade Rede Credenciada preenchido com um exemplo

O buscador condensado e a URL com o embed completo obrigatoriamente devem estar no mesmo domínio, devido à permissões de segurança nos browsers.

 

Conclusão

Agora você está pronto para incorporar a funcionalidade do aplicativo em sua página da web. Siga as etapas descritas acima para obter o código de incorporação, configurar a segurança e adicionar o código à página desejada. Lembre-se de que o recurso de incorporação só funcionará nos domínios registrados na seção de segurança do aplicativo.

Observação: Certifique-se de fornecer todas as informações necessárias para utilizar corretamente o recurso de incorporação em suas páginas da web, incluindo os requisitos de segurança e as instruções de incorporação.

 

Vídeo Explicativo

92891f91-1f58-4a57-ae82-0cfb853bd9d5.mp4

 

Related content

Mobile Saúde - Mosia Omnichannel