Configurar autenticação de mensagem para comunicação de entrada

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 2 min. de leitura
  • Você pode configurar a autenticação de mensagem para a API Virtual Agent em vez de Básica ou OAuth. A autenticação de mensagem envolve a configuração de tokens estáticos ou de hash, a configuração da autenticação do provedor e a definição da identidade do canal.

    Antes de Iniciar

    Siga as etapas em Revise o endpoint REST de entrada e configure a autenticação de entrada.

    Função necessária: admin

    Procedimento

    1. Configure o token executando um dos procedimentos a seguir, dependendo do tipo de token.
      • Token estático:
        1. Navegue até Todos e, em seguida, insira token_verification.list no filtro.
        2. Clique em Novo.
        3. No formulário Verificações de token, preencha os campos.
          Campo Descrição
          Nome Nome do token de autenticação, como B2BTestAppAuthToken.
          Descrição Descrição do token de autenticação, como Token de autenticação da aplicação de teste B2B.
          Token Insira um token de autenticação que você gerou usando qualquer programação geral ou linguagem de script, ou clique em Gerar token seguro nos Links relacionados.
        4. Clique em Enviar.
      • Token de hash:
        1. Navegue até Todos e, em seguida, insira hash_message_verification.list no filtro.
        2. Clique em Novo.
        3. No formulário Verificação de mensagem hash, preencha os campos.
          Campos Descrição
          Nome Nome do token de autenticação, como B2BTestAppAuthToken.
          Descrição Descrição do token de autenticação, como Token de autenticação da aplicação de teste B2B.
          Segredo Token de autenticação (cadeia de caracteres aleatória).
        4. Clique em Enviar.
    2. Configure a autenticação do provedor para autenticação baseada em token.
      1. Navegue até Todos e, em seguida, insira message_auth.list no filtro.
      2. Clique em Novo.
      3. No formulário Message Auths, preencha os campos.
        Campo Descrição
        Nome Nome da autenticação da mensagem, como Token de autenticação B2B.
        Provedor Nome do provedor.
        Nome do grupo Não necessário.
        Portal de serviços Não necessário.
        Verificação de mensagem de entrada Selecione o token estático ou o token de mensagem hash que você criou.
        Criação de mensagem de saída Este campo não é compatível com a API Virtual Agent. Selecione o token estático ou o token de mensagem hash que você criou.
        Token de serviço de saída Este campo não é compatível com a API Virtual Agent.
      4. Clique em Enviar.
    3. Defina a identidade do canal.
      1. Navegue até Todos e, em seguida, insira sys_cs_provider_application.list no filtro.
      2. Selecione o registro Aplicação do provedor de VA de bot a bot para abri-lo.
      3. No formulário Identidade do canal do provedor, localize o campo Autenticação da mensagem e selecione a autenticação da mensagem que você configurou anteriormente.

        Formulário de identificação de canal do provedor para o registro da aplicação do provedor bot a bot de VA, com o campo Autenticação de mensagem destacado.

      4. Clique em Atualizar.
    4. Somente para autenticação baseada em token de hash, envie a x-b2b-signature nos cabeçalhos da solicitação.
      O valor é o valor codificado HmacSHA1 da carga da solicitação, que usa o token criado na instância ServiceNow. Por exemplo, no Postman, siga estas etapas:
      1. Nos cabeçalhos, defina a assinatura x-b2b como {{hashValue}}.

        Exemplo de codificação do Postman nos cabeçalhos.

      2. Na área Script de pré-solicitação, defina o token da seguinte forma:
        pm.environment.set('hashValue', CryptoJS.HmacSHA1(JSON.stringify(JSON.parse(request.data)), '<insert your token>').toString(CryptoJS.enc.Hex));

        Exemplo de script de pré-solicitação do Postman que mostra onde inserir o token.

    O que Fazer Depois

    Configure o endpoint REST de resposta de saída e a autenticação de saída para a API Virtual Agent