Instale a API Virtual Agent

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 1 min. de leitura
  • Instale o app API Virtual Agent para integrar qualquer interface de chat ou um bot com ServiceNow® Virtual Agent ou Bate-papo do agente.

    Antes de Iniciar

    Se você estiver atualizando de uma versão anterior à versão 2 e se a autenticação for necessária para sua instância, será necessário reverter a personalização antes de atualizar. Para essas versões, o upgrade ignora o serviço REST de script quando a autenticação estiver ativada. Para obter mais informações, consulte Revert a customization.
    Você deve atender aos seguintes requisitos:
    • Certifique-se de que o aplicativo e todos os seus aplicativos ServiceNow Store associados tenham direitos válidos ServiceNow. Para obter mais informações, consulte Obter direito para um ServiceNow produto ou aplicação.
    • Confira a lista de aplicações da API do Virtual Agent em ServiceNow Store para obter informações sobre dependências, requisitos de licenciamento ou assinatura e compatibilidade de lançamento.
    • Certifique-se de ter ativado o plug-in Glide Virtual Agent (com.glide.cs.chatbot), que ativa o plug-in Conversational Custom Chat Integration (com.glide.cs.custom.adapter).

      Para obter mais informações sobre este plug-in, consulte Como ativar Virtual Agent.

    Nota:
    A API Virtual Agent requer uma licença Pro semelhante à de Virtual Agent.

    Função necessária: admin ou virtual_agent_admin

    Por Que e Quando Desempenhar Esta Tarefa

    A tabela de controle de bot para bot [sys_cs_bot_to_bot_control] é instalada com a API Virtual Agent. Esta tabela rastreia o número de vezes que uma tarefa específica em um tópico é executada. Você pode usar esta tabela para depuração. Por exemplo, use-o para determinar se Virtual Agent está travado em um controle ou tópico específico.

    Procedimento

    1. Navegar até Tudo > Aplicações do sistema > Todas as aplicações disponíveis > Tudo.
    2. Encontre a aplicação da API Virtual Agent usando os critérios de filtro e a barra de pesquisa.

      Você pode pesquisar a aplicação pelo nome ou ID. Se você não conseguir encontrar a aplicação, talvez seja necessário solicitá-la ao ServiceNow Store.

      Acesse o site ServiceNow Store para ver todos os aplicativos disponíveis e obter informações sobre como enviar solicitações para a loja. Para obter informações sobre notas de versão cumulativa para todos os aplicativos liberados, consulte as ServiceNow Store notas de versão do histórico de versão.

    3. Escolha uma versão na lista e selecione Instalar.

      Na caixa de diálogo Revisar detalhes da instalação que é exibida, todas as dependências instaladas junto com sua aplicação são listadas.

    4. Se for solicitado, siga os links para ServiceNow Store e obtenha direitos adicionais para as dependências.

    O que Fazer Depois

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