Configuração Básica

• Um Canal Oracle Web. A criação do canal gera o ID do Canal e a Chave Secreta que você precisa para inicializar o aplicativo de chat.
• O URL do Oracle Chat Server.
• O Oracle Web SDK (localizado em SDKs do Cliente Nativo Oracle para Ambientes Nativos OCI) da página de download do ODA e do OMC da Oracle Technology Network. Faça o download deste ZIP e extraia-o no seu sistema local. Este ZIP inclui um guia do usuário que descreve as classes do SDK e um aplicativo de amostra que demonstra muitas de suas funcionalidades.

• A autenticação é aplicada usando JWT (JSON Web Tokens). O servidor de backend do cliente gera o token JWT, que é informado para o Oracle Web SDK. Este token é usado para cada solicitação a um servidor de fala, texto ou anexo do ODA.

  Observação
  
  Para proteger o acesso ao canal, o token sempre deve ser gerado por um servidor remoto. Ele nunca deve ser gerado no browser do cliente.

  Quando o aplicativo Web precisa se conectar a um servidor ODA, ele primeiro solicita o token do servidor de backend e, em seguida, adiciona-o ao cabeçalho Autorização. O servidor ODA valida o token, avalia as declarações e, em seguida, abre o soquete ou rejeita a conexão.

  Dica:

  Este artigo orienta na execução do SDK com um canal autenticado.
• Modo não autenticado – Use o modo não autenticado quando o cliente não puder gerar tokens JWT assinados, quando não houver mecanismo de autenticação em vigor ou quando o widget do cliente já estiver protegido e visível para usuários autenticados.

1. Escolha Desenvolvimento e Canais no menu.
2. Escolha Usuários.
3. Clique em Adicionar Canal e em Oracle Web como o tipo de canal.
4. Preencha a caixa de diálogo:
   • Informe o nome do canal.
   • Para conexões autenticadas:
     • Ative a opção Autenticação do Cliente Ativada para determinar se o SDK está se conectando a um canal ativado para autenticação do cliente.
     • O canal só se comunicará com os sites dos domínios que você adicionar como uma lista separada por vírgulas. Por exemplo, *.corp.example.com, *.hdr.example.com. Inserir um único asterisco (*) permite o acesso irrestrito ao canal de qualquer domínio. Normalmente, você só inseriria um único asterisco durante o desenvolvimento. Para produção, você adicionaria uma lista de permissões de domínios.
     • No campo Expiração Máx. do de Token (Minutos), defina o tempo máximo para o token JWT.
   • Para conexões não autenticadas:
     • Desative a opção Autenticação do Cliente Ativada.
     • Informe uma lista separada por vírgulas de domínios que podem acessar o canal. Se os domínios desta lista de permissões incluírem asteriscos (*.hdr.example.com) ou se a lista de permissões não for completamente conhecida, você poderá considerar uma conexão autenticada.
   • Defina o tempo de expiração da Sessão.
   • Clique em Criar. O Oracle Digital Assistant gerará o ID do Canal e a Chave Secreta que você precisa para inicializar o SDK. Mantenha-os à mão, pois você precisará dessas informações ao configurar a página HTML para hospedar o widget de chat.
5. Roteie o canal para a habilidade ou o assistente digital.
6. Alterne Canal Ativado para Ativado.

1. No arquivo ZIP extraído do Oracle Web SDK submetido a download, localize o arquivo web-sdk.js (localizado no diretório native-client-sdk-js).
2. Salve o arquivo web-sdk.js (localizado no diretório native-client-sdk-js do ZIP extraído) no diretório do projeto. Anote o local do arquivo, pois você precisará dele para definir a propriedade <WebSDK URL> no código da tag <script>.
3. Crie um arquivo JavaScript com a função a seguir que inicializa o SDK. Chamamos esse arquivo de settings.js na amostra que é fornecida com o SDK.

   // settings.js
   const chatSettings = {
       URI: '<Server URI>',
       channelId: '<Channel ID>',
       userId: '<User ID>' // optional; random ID will be generated if omitted
   };
   
   function initSDK(name) {
       // Wait until the SDK global is available
       if (!document || !window.WebSDK) {
           setTimeout(() => initSDK(name), 2000);
           return;
       }
   
       const ns = name || 'Bots';
       const Bots = new WebSDK(chatSettings);
   
       let firstOpen = true;
       Bots.on(WebSDK.EVENT.WIDGET_OPENED, async () => {
           if (firstOpen) {
               try {
                   await Bots.connect();
                   console.log('Connection Successful');
               } catch (error) {
                   console.error('Connection failed', error);
               }
               firstOpen = false;
           }
       });
   
       window[ns] = Bots;
   }

4. Defina as seguintes propriedades:
   • URI - O nome do host no URL da instância do Oracle Digital Assistant. Somente o primeiro caminho (/) precisa ser passado aqui. Você pode transmitir esse URL com ou sem o protocolo (https://).
   • channelId - O ID do Canal que é gerado ao criar o canal Oracle Web. Essa propriedade é obrigatória porque conecta o widget à habilidade subjacente.
   • userId - Um ID de usuário. Quando você fornece esse valor, a base de usuários dessa habilidade pode ser rastreada pelas métricas exclusivas do usuário no Insights. Quando você não fornecer um ID de usuário, mas o SDK gerará um com cada nova sessão. Esta propriedade é opcional para conexões não autenticadas.
5. Em sua página HTML, faça referência aos locais do seu arquivo JS (setting.js no exemplo a seguir) à biblioteca web-sdk.js e ao namespace do Web SDK, que geralmente é Bots. Use este namespace para chamar as APIs públicas. Por exemplo, se você definir o namespace como Bots, chamará as APIs como Bots.<API>(). Para saber mais sobre as diversas funções e eventos, consulte o guia do usuário (disponível como um arquivo readme e um documento HTML) que está incluído no arquivo ZIP do Oracle Web SDK.

   
       <script src="settings.js" defer></script>
       <script src="<WebSDK URL>" onload="initSDK('Bots')" defer></script>
   

async function generateToken() {
    // Return a signed JWT string from your backend
    const response = await fetch('https://yourbackend.com/endpointToGenerateJWTToken');
    if (!response.ok) {
        throw new Error('Token fetch failed');
    }
    return response.text(); // or response.json() depending on your endpoint
}

const Bots = new WebSDK(
    {
        URI: 'oda-instance.com',
        clientAuthEnabled: true
    },
    generateToken
);