--- sourceDocument: Interfaces conversacionais de Yokohama sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/yokohama/conversational-interfaces Release : - yokohama ft:locale : - pt-BR ft:publication_title : - Interfaces conversacionais de Yokohama ft:clusterId : - convint bundleId : - convint workflow : - Platform --- # Usando Virtual Agent API # Usando Virtual Agent API {#ariaid-title1} * Versão de lançamento: Yokohama * * Atualizado 30 de jan. de 2025 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 min. de leitura Use o. ServiceNow® Virtual AgentApp de API para integrar qualquer interface de bate-papo ou um bot ServiceNow® Virtual Agentou Bate-papo do agente. O app está disponível no ServiceNow® Store. ## Visão geral do Virtual Agent API {#virtual-agent-api__section_cxx_ldc_qmb} . Virtual AgentA API é uma REST API. Esta API é criada com base na estrutura de integração de bate-papo personalizada conversacional fornecida com Virtual Agenta partir de Parisversão. A API habilita ServiceNowdesenvolvedores, usuários avançados e administradores para usar Virtual Agentde uma das seguintes maneiras: Bot autônomo : Uso Virtual Agentcomo 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 o. Virtual Agente. Bate-papo do agentepor vários canais usando esta integração. Bot secundário : Uso Virtual Agentcomo 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 desenvolvido internamente. Seus bots secundários, como ServiceNowo bot pode lidar com tipos específicos de solicitações do usuário final, como tíquetes de serviço ou reservas. Bot Interconnect : Uso Virtual Agent Bot Interconnectcomo o bot primário em um ambiente de bate-papo diversificado. Bot Interconnectcria uma experiência de bate-papo unificada e oferece aos usuários finais acesso a vários canais e a uma ampla variedade de tarefas empresariais disponíveis em ServiceNow. . Virtual AgentA API é útil para criar integrações de servidor para servidor. No entanto, para integrações que exigem a transformação de controles incompatíveis que devem ser renderizados em sua interface de bate-papo existente, considere usar o. [Estrutura de integração de bate-papo personalizada](https://servicenow-prod.fluidtopics.net/ZxeaMtO~hxqXCiJyr0PSZg "A estrutura de integração de bate-papo personalizada conversacional é uma estrutura poderosa que consiste em APIs de script e configurações para trazer o. ServiceNow Virtual Agentpara qualquer interface conversacional."). Para obter informações sobre recursos como o formato de URL e os parâmetros de solicitação e resposta compatíveis no Virtual AgentAPI, consulte [API de integração de bot do Virtual Agent](https://www.servicenow.com/docs/access?context=bot-api&version=yokohama&pubname=yokohama-api-reference&ft:locale=en-US). ![Link do vídeo para a Virtual Agent Academy.]() [Aumente suas experiências com a API do Virtual Agent](https://www.youtube.com/watch?v=cyhmMyG4jKk)(Vídeo da Virtual Agent Academy) ## . Virtual AgentA API 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 um JSON de solicitação POST para o endpoint REST de entrada (por meio da REST API com script). 3. . Now Platformautentica e processa a solicitação, que é enviada para Virtual Agentou um atendente. 4. . Now PlatformEnvia um JSON de PÓS-resposta 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. Endpoints REST de entrada e saída no Virtual AgentAPI Para ver uma demonstração do Virtual AgentE 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} . Virtual AgentA API não é compatível com os seguintes recursos: * Converse com a identidade visual por meio deste Virtual AgentIntegração de API {#virtual-agent-api__ul_yqy_r1l_2qb} ## Compatibilidade de versão e versão {#virtual-agent-api__section_t11_5zb_dqb} {#virtual-agent-api__table_syv_gzb_dqb__entry__2} | Versão | Versões compatíveis | |-|-| | 3.14.3 | Yokohama | | 3.14.2 | Xanadu | | 3.14.1 | Xanadu | | 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. Virtual Agent Versão da API e compatibilidade da versão] {#virtual-agent-api__table_syv_gzb_dqb} Nota: . Virtual AgentA API requer uma licença Pro semelhante à de Virtual Agent. * **[Virtual Agent Recursos da API](https://servicenow-prod.fluidtopics.net/cpP0bStpgtVN~bqS~67dzw)** Você pode usar o. Virtual AgentAPI para integrar muitos dos mesmos recursos que estão disponíveis em Virtual Agente. Bate-papo do agenteem seu ambiente de bate-papo. O suporte a recursos varia de acordo com seu ServiceNowE o número da versão do app Store da API. * **[Virtual Agent Recursos de API disponíveis na versão 2,0.x da Loja](https://servicenow-prod.fluidtopics.net/2gl7RbtxZFuuTRMauQvesg#va-api-features-v2)** Virtual AgentA API versão 2,0.x fornece acesso a mais dos mesmos recursos que estão disponíveis em Virtual Agente. Bate-papo do agente, incluindo suporte de controle avançado e notificações. * **[Virtual Agent API Recursos disponíveis na versão Store 3,0.x](https://servicenow-prod.fluidtopics.net/LqCvyOZlAe2s2wPfNhjq8Q#va-api-features-v3)** Virtual Agent APIa versão 3,0.x fornece acesso a mais dos mesmos recursos que estão disponíveis em Virtual Agente. Bate-papo do agente, Incluindo a capacidade de carregar arquivos de um URL privado e aprimoramentos de handshake síncrono. * **[Instale o. Virtual AgentAPI](https://servicenow-prod.fluidtopics.net/FZO9Zu9YYHMhiVHbfnK7FQ)** Instale o. Virtual AgentApp de API para integrar qualquer interface de bate-papo ou um bot ServiceNow® Virtual Agentou Bate-papo do agente. * **[Revise o endpoint REST de entrada e configure a autenticação de entrada](https://servicenow-prod.fluidtopics.net/oxZ2GnMEPMHrPdf0zTOwBA)** Depois de instalar o. Virtual AgentAPI, navegue até o recurso REST API com script para revisar o endpoint e configurar a autenticação. * **[Configure a Autenticação de mensagem para comunicação de entrada](https://servicenow-prod.fluidtopics.net/baeCkkHbi0f3xdzf46XIXw)** Você pode configurar a Autenticação de mensagem para Virtual AgentAPI 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 da resposta de saída e a autenticação de saída para o. Virtual AgentAPI](https://servicenow-prod.fluidtopics.net/7Y3WK~W3_WewJTajdTPLMQ)** Especifique o URL do endpoint de saída para o qual Virtual Agentas respostas foram publicadas. Configure a autenticação de saída. * **[Virtual Agent integração de bot para bot](https://servicenow-prod.fluidtopics.net/9zWfwFcgD_A_042UCLp2sQ)** . Virtual AgentA API é compatível com ambientes que usam vários bots. Nessa situação, um bot primário se comunica com bots secundários de terceiros, como um ServiceNowbot. * **[Encerrando conversas ociosas de bot para bot](https://servicenow-prod.fluidtopics.net/6h9lpNbEzHOSBNl2X6V0SQ)** Nas integrações de bot para 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 de hora em hora, todos os dias. * **[Configure várias aplicações do provedor](https://servicenow-prod.fluidtopics.net/xVlA3eFo486_Av1OQK_oTg)** 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 APIe você precisa distinguir entre eles. * **[Transformar solicitação e resposta da API do Virtual Agent](https://servicenow-prod.fluidtopics.net/c5Rb5KyPRLq_6DLCtgrtyg)** 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 Assistexperiência em Virtual Agent API](https://servicenow-prod.fluidtopics.net/60iI_ukUSlJ2OyzK3pIVpg)** Habilitar Now Assistexperiência em Virtual Agent APIPara oferecer suporte às habilidades de IA generativa em vários canais de provedor.