--- sourceDocument: Interfaces conversacionais do Xanadu sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/conversational-interfaces Release : - xanadu ft:locale : - pt-BR ft:publication_title : - Interfaces conversacionais do Xanadu ft:clusterId : - convint bundleId : - convint workflow : - Platform --- # Como usar Virtual Agent API # Como usar Virtual Agent API {#ariaid-title1} * Versão de lançamento: Xanadu * * Atualizado 1 de ago. de 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 min. de leitura Use o app de API ServiceNow® Virtual Agent para integrar qualquer interface de bate-papo ou um bot com ServiceNow® Virtual Agent ou Bate-papo do agente. O app está disponível no ServiceNow® Store. ## Visão geral {#virtual-agent-api__section_cxx_ldc_qmb} A API Virtual Agent é uma API REST. Esta API é criada na estrutura de integração de bate-papo personalizada que é fornecida com Virtual Agent a partir da versão Paris. A API permite que desenvolvedores de ServiceNow, usuários avançados e administradores usem Virtual Agent de uma das seguintes maneiras: Bot autônomo : Use Virtual Agent como um bot autônomo que você integra com a empresa ou com qualquer outra interface de bate-papo de terceiros que ofereça suporte a interfaces conversacionais. Seus usuários finais podem interagir com Virtual Agent e Bate-papo do agente por meio de vários canais usando esta integração. Bot secundário : Use Virtual Agent como um bot secundário em um ambiente que tem vários bots especializados gerenciados por um bot primário. Neste cenário, um bot primário gerencia a comunicação com bots secundários em nome do usuário final. Um bot primário pode ser IBM Watson Assistant, Microsoft LUISou um bot primário interno. Seus bots secundários, como o bot ServiceNow, podem lidar com tipos específicos de solicitações de usuário final, como tíquetes de serviço ou reservas. Bot Interconnect : Use Virtual Agent Bot Interconnect como o bot primário em um ambiente de bate-papo diversificado. Bot Interconnect cria uma experiência de bate-papo unificada e fornece aos usuários finais acesso a vários canais e a uma ampla variedade de tarefas corporativas que estão disponíveis em ServiceNow. A API Virtual Agent é útil para criar integrações de servidor a servidor. No entanto, para integrações que exigem a transformação de controles sem suporte que devem ser renderizados em sua interface de bate-papo existente, considere o uso da [Estrutura de integração de bate-papo personalizada](https://servicenow-prod.fluidtopics.net/F8vvCjzln7z5T_fdKMXXzg "A estrutura de integração de bate-papo personalizada de conversação é uma estrutura avançada que consiste em APIs programáveis e configurações para trazer o ServiceNow Virtual Agent para qualquer interface de conversação."). Para obter informações sobre recursos como o formato de URL e os parâmetros de solicitação e resposta compatíveis na API Virtual Agent, consulte [API de integração de bots do Virtual Agent](https://www.servicenow.com/docs/access?context=bot-api&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US). ![Link de vídeo para a Virtual Agent Academy.]() [Melhore suas experiências com a API Virtual Agent](https://www.youtube.com/watch?v=cyhmMyG4jKk) (vídeo da Virtual Agent Academy) ## Como a API Virtual Agent funciona {#virtual-agent-api__section_ivs_d2r_fnb} O diagrama a seguir mostra como a REST API processa a entrada do usuário de uma interface de bate-papo de terceiros ou de um bot primário e, em seguida, gera uma resposta de bot. 1. O usuário fornece entrada para um bot primário ou interface de bate-papo de terceiros. 2. O bot envia uma solicitação POST JSON para o endpoint REST de entrada (via REST API de script). 3. O Now Platform autentica e processa a solicitação, que é enviada para o Virtual Agent ou para um atendente. 4. O Now Platform envia um JSON de resposta POST do endpoint REST de saída (via REST API) de volta para o bot. 5. O bot primário ou as interfaces de bate-papo de terceiros exibem a resposta para o usuário. {#virtual-agent-api__ol_pwf_jqc_kyb} Figura 1. Pontos de extremidade REST de entrada e saída na API Virtual Agent Para ver uma demonstração da Virtual Agent API e perguntas frequentes, consulte [Introdução às APIs do Virtual Agent](https://community.servicenow.com/community?id=community_article&sys_id=080e3903dbc4e4107d3e02d5ca96198c) no site da comunidade. ## Limitações {#virtual-agent-api__section_xqy_r1l_2qb} A API Virtual Agent não é compatível com os seguintes recursos: * Bate-papo da identidade visual por meio desta integração de API Virtual Agent {#virtual-agent-api__ul_yqy_r1l_2qb} ## Compatibilidade de versão e lançamento {#virtual-agent-api__section_t11_5zb_dqb} {#virtual-agent-api__table_syv_gzb_dqb__entry__2} | Versão | Lançamentos compatíveis | |-|-| | 3.10.0 | Washington DC | | 3.9.x | Vancouver | | 3.8.x | Vancouver | | 3.7.x | Utah | | 3.5.x | Tokyo | | 3.0.x | San Diego | | 2.0.x | Rome Um subconjunto de recursos é compatível com Quebec. | | 1.3.0 | Quebec | | 1.0.12 | Quebec | | 1.0.9 | Paris | [Tabela 1. Versão da API Virtual Agent e compatibilidade de lançamento] {#virtual-agent-api__table_syv_gzb_dqb} Nota: A API Virtual Agent requer uma licença Pro semelhante à de Virtual Agent. * **[Recursos da API Virtual Agent](https://servicenow-prod.fluidtopics.net/XknZmMOgHfU1MmqGsv3AjA)** Você pode usar a API Virtual Agent para integrar muitos dos mesmos recursos que estão disponíveis em Virtual Agent e Bate-papo do agente em seu ambiente de bate-papo. O suporte ao recurso varia de acordo com a versão ServiceNow e o número da versão da aplicação da Store da API. * **[Recursos de API Virtual Agent disponíveis na versão na Store 2.0.x](https://servicenow-prod.fluidtopics.net/btQtPmwMtb4bxbFwnP131A#va-api-features-v2)** A API Virtual Agent versão 2.0.x fornece acesso a mais recursos que estão disponíveis em Virtual Agent e Bate-papo do agente, incluindo suporte avançado de controle e notificações. * **[Recursos de Virtual Agent API disponíveis na versão na Store 3.0.x](https://servicenow-prod.fluidtopics.net/nfYBzD4AtOhCZmi_JJNt3g#va-api-features-v3)** A Virtual Agent API versão 3.0.x fornece acesso a mais dos mesmos recursos que estão disponíveis em Virtual Agent e Bate-papo do agente, incluindo a capacidade de carregar arquivos de um URL privado e melhorias de sincronia. * **[Instale a API Virtual Agent](https://servicenow-prod.fluidtopics.net/iyuFCigG0piosx7ZMDGkZg)** Instale o app API Virtual Agent para integrar qualquer interface de chat ou um bot com ServiceNow® Virtual Agent ou Bate-papo do agente. * **[Revise o endpoint REST de entrada e configure a autenticação de entrada](https://servicenow-prod.fluidtopics.net/RNA_e5nsQ_A0vkZX42oVdg)** 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. * **[Configurar autenticação de mensagem para comunicação de entrada](https://servicenow-prod.fluidtopics.net/4ORJwq1UgPL9F8~yKFsTtA)** 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. * **[Configure o endpoint REST de resposta de saída e a autenticação de saída para a API Virtual Agent](https://servicenow-prod.fluidtopics.net/FXkkw6oNXZqwqDMkP24jOw)** Especifique a URL do endpoint de saída para a qual as respostas Virtual Agent são postadas. Configurar autenticação de saída. * **[Integração bot a bot Virtual Agent](https://servicenow-prod.fluidtopics.net/DCauY~dR_1oe28P2OGHYWQ)** A API Virtual Agent oferece suporte a ambientes que usam vários bots. Nesta situação, um bot primário se comunica com bots secundários de terceiros, como um bot ServiceNow. * **[Como fechar conversas bot a bot ociosas.](https://servicenow-prod.fluidtopics.net/0F4faiWiazjMoZglG1Y9oQ)** Em integrações de bot a bot (API do Virtual Agent), as conversas abandonadas que estão "ociosas" por mais de uma hora são encerradas automaticamente pelo trabalho agendado, Time Out Abandoned B2B Conversations. Este trabalho é executado por hora todos os dias. * **[Configurar várias aplicações do provedor](https://servicenow-prod.fluidtopics.net/1~awI8TIhNyR8fjr_A4c2w)** Você pode configurar várias aplicações de provedor para oferecer suporte a casos de uso em que há vários bots primários usando Virtual Agent API e você precisa distinguir entre eles. * **[Transformar solicitação e resposta da API do Virtual Agent](https://servicenow-prod.fluidtopics.net/YeAvjp9vCSNPIp4Warn6tw)** Você pode transformar a solicitação e a resposta da API do Virtual Agent em formatos compatíveis por meio dos pontos de extensão com script fornecidos na API do Virtual Agent. * **[Habilitar Now Assist experiência em Virtual Agent API](https://servicenow-prod.fluidtopics.net/GNeTgGRqbU7yybWzM2RyRA)** Habilite a experiência Now Assist em Virtual Agent API para oferecer suporte a habilidades de IA generativa em vários canais do provedor.