Revise o endpoint REST de entrada e configure a autenticação de entrada

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 1 min. de leitura
  • Depois de instalar a API Virtual Agent, navegue até o recurso de API REST de script para revisar o endpoint e configurar a autenticação.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Serviços web do sistema > Serviços web com script > Scripted REST APIs.
    2. Selecione o registro de integração de bot do VA para abri-lo.
    3. Na guia Recursos, abra o registro Integração de BOT.
    4. Revise os detalhes do recurso de API REST de entrada.

      O formato é: https://<customer instance>/api/sn_va_as_service/bot/integration

      Revise o valor do caminho do recurso para o endpoint REST.

      Para obter uma descrição dos parâmetros de solicitação e uma solicitação de envio de exemplo, consulte API Virtual Agent Bot Integration.

    5. Na guia Segurança na mesma página, marque a caixa de seleção Requer autenticação.
      Marque a caixa de seleção Requer autenticação.
    6. Configure a Autenticação do Provedor usando qualquer um destes métodos: Básica, OAuth, Hash ou Token estático.
      Nota:
      O uso de convidados via Basic ou OAuth já é compatível com o uso imediato quando você seleciona Requer autenticação. Para oferecer suporte à vinculação de conta de usuário, você deve usar a autenticação estática ou baseada em token de hash. Você pode usar a autenticação baseada em token (Estático ou hash) com ou sem autenticação Básica ou OAuth. O token pode ser passado no corpo da solicitação ou no cabeçalho. Se o token for especificado em ambos os locais, aquele no cabeçalho será aceito.
      Faça um dos seguintes:

    O que Fazer Depois

    Se você estiver usando a autenticação de mensagem, Configurar autenticação de mensagem para comunicação de entrada.

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