Please log in to continue
WalkMe stores your data in the region chosen during account setup.
We have data centers in the US and EU that follow local privacy and compliance laws. If you're not sure which region to select, check with your admin.
Para fornecer mais flexibilidade e abrir a Pesquisa Corporativa para novos recursos, criamos a API de Pesquisa de Integrações. A API de Integrações é a maneira de integrar resultados de pesquisa de terceiros no menu Enterprise Search do desktop.
A API de pesquisa de integrações permite conectar integrações à Pesquisa Empresarial para que você possa adicionar recursos de pesquisa e controlar a experiência no menu da área de trabalho.
Este artigo apresenta o menu da área de trabalho - API de pesquisa de integrações.
As integrações de terceiros adicionam dois recursos principais ao menu do desktop:
Para criar uma nova integração conectada à API de Integrações, duas etapas são necessárias:
Ambos os fluxos serão explicados neste documento.
Para criar uma nova integração, será necessário fornecer ao WalkMe os seguintes parâmetros:
|
Parâmetro |
Descrição |
| apiUrl |
O ponto de extremidade ao qual os serviços de menu da área de trabalho enviarão a solicitação de consulta de pesquisa. Obrigatório |
| apiKey |
O identificador exclusivo do serviço autentica a origem da solicitação. Obrigatório |
| GUID do sistema |
Localizado na tela Configurações > Sobre do aplicativo do menu da área de trabalho. Obrigatório |
| appDescription |
Descrição de uma linha para o aplicativo, que será exibida para os usuários na página Integrações. Exemplo para um formato adequado- Pesquise arquivos do Google Drive diretamente do menu do desktop. Obrigatório |
| customName |
Nome da integração, que aparecerá na página Integrações, nos resultados da pesquisa e no filtro do aplicativo. Obrigatório |
| customImage |
URL do ícone que aparecerá na página Integrações, nos resultados da pesquisa e no filtro do aplicativo. Obrigatório |
Para criar uma nova integração, entre em contato com o Gerente de Sucesso do Cliente com os parâmetros listados na tabela acima e o GUID do sistema relevante.
No futuro, esse recurso será adicionado ao Console WalkMe e será gerenciado pelo administrador do sistema.
Conforme descrito abaixo em a. Na figura abaixo, o fluxo de configuração é iniciado no Banco de Dados (no futuro será feito no Console). Depois de nos fornecer os parâmetros de configuração, testamos a integração para garantir que obtemos uma resposta adequada.
Este teste será feito com um "usuário fictício" criado pela nossa equipe. Não requer nenhuma configuração ou instalação no lado do serviço externo, pois será uma chamada de consulta de pesquisa regular que indicará se o fluxo foi concluído com sucesso.
O gatilho para o fluxo é: o usuário final pesquisa algo no aplicativo do menu do desktop.
Uma chamada de API será gerada para o ponto final da API (URL) com a chave da API fornecida, de acordo com as seguintes condições:
Depois que essa consulta de pesquisa for acionada, a API de Pesquisa de Integrações enviará uma chamada de consulta de pesquisa com os parâmetros.
Enviado da API de Integrações:
POST <apiURL>/(search)Content-type: application/jsonHeaders:{ Authorization: <apiKey>}Body:{ "user": "user@email.com" "system": "652c91b1ec444c76a313a68f69478b93" "env": "prod" "term": "itay"} |
|
Parâmetro |
Descrição |
| usuário | E-mail do usuário |
| sistema | GUID do sistema- uma string de 32 caracteres |
| env | Tipo de ambiente de menu da área de trabalho. Valores disponíveis-
|
| termo | Consulta de pesquisa que está sendo digitada no aplicativo de menu do desktop |
Enviado para a API de Integrações (como uma chamada POST):
Body:[{ "id": "b2f8510d-9547-4d53-978f-6fc24371c113", "title": "Creating a user", "description": "WalkMe does not collect personally identifiable information (PII) other than IP addresses in logs for security purposes, end users' approximate geolocation (country and city in which they are located) and masked IP addresses for the ongoing operation of the WalkMe system.", "mimeType": "Answers", "externalType": "Article", "created": "2022-01-30T14:35:16.57Z", "modified": "2022-01-30T14:37:07.40Z", "source": "confluence", "category": "Gitlab Service User creation and configuration", "detail": "Account Management", "relationaltime": "2022-01-30T14:35:16.57Z" }}] |
| Atributo | Tipo | Descrição |
| id | String |
O identificador exclusivo do item. Obrigatório |
| título | String |
O nome do item. Obrigatório |
| descrição | String |
A descrição/resumo do item. Se preenchido, o título do resultado da pesquisa será exibido em negrito, enquanto a descrição será exibida abaixo. Opcional |
| link | URL |
O URL para acessar o item depois de clicar no resultado da pesquisa. Obrigatório |
| mimeType | String |
A categoria de filtro na qual o item deve ser exibido. Precisa ser uma correspondência exata de uma das seguintes opções que aparecem nesta lista.
Obrigatório |
| externalType | String |
O tipo de item. Por exemplo: Artigo, Painel, Caso, etc. Se preenchido, ele será exibido no item ao lado do nome da integração. Opcional |
| criado | Data e hora |
A data e hora em que o item foi criado. Esse parâmetro não é exibido na interface do usuário, mas é usado para fins de classificação. Opcional |
| modificado | Data e hora |
O item de data e hora foi atualizado recentemente. Esse parâmetro não é exibido na interface do usuário, mas é usado para fins de classificação. Opcional |
| copiar | String |
Se preenchido, um botão de cópia será exibido no resultado da pesquisa. Ao clicar nesse botão, o texto fornecido será copiado (link do item, nome, ID etc.). Normalmente, ele é preenchido com o link do item. Opcional |
| confiança | Decimal |
Parâmetro a ser usado para exibir a precisão da resposta (em porcentagem). Se preenchido, ele será exibido na interface do usuário dos resultados da pesquisa. Opcional |
| fonte | String |
Exibir a origem da resposta (por exemplo, Confluence). Ele será exibido na interface do usuário dos resultados da pesquisa ao lado de um ícone de lupa. Opcional |
| categoria | String |
Parâmetro a ser usado pelo Ask-AI para exibir a categoria do artigo ("breadcrumbs"). Se preenchido, ele será exibido na interface do usuário dos resultados da pesquisa acima do título. Opcional |
| poweredBy | String |
Se preenchido, uma nota será exibida na interface do usuário dos resultados da pesquisa no canto inferior direito. Observe que, quando preenchidos, o nome e o ícone da integração não serão exibidos no resultado. Opcional |
| detalhe | String |
Se preenchidos, esses dados serão exibidos na interface do usuário do resultado da pesquisa (após o nome da integração e externalType). Opcional |
| relationalTime | Data e hora |
Se preenchidos, esses dados serão exibidos na interface do usuário dos resultados da pesquisa, no final da mesma. Exibirá um tempo relacional de acordo com a data fornecida versus hora atual (por exemplo, há 3 dias). Opcional |
Restrições
Os campos String são restritos a 255 caracteres.
Embora, na maioria dos casos, o fluxo resulte em uma resposta "HTTP 200" com um texto simples 'ok' indicando que os resultados da pesquisa foram exibidos com sucesso, precisaremos nos preparar para cenários em que as tentativas de enviar resultados da pesquisa falharão.
Os erros que aparecem nesta seção estão sendo gerados no lado da API de Integrações e devem indicar com a maior precisão possível a causa do erro.
A resposta da API pode gerar erros ("HTTP 400") ao receber solicitações malformadas, quando são utilizadas chaves que não são mais válidas ou quando algo verdadeiramente excepcional impede que ela chegue aos resultados da pesquisa.
|
Erro |
Descrição |
| invalid_structure | Normalmente, indica que a solicitação recebida está mal formada – talvez o JSON esteja estruturado incorretamente ou o texto da mensagem não tenha sido escapado corretamente. A solicitação não deve ser tentada novamente sem correção. |
| api_key_invalid | Indica que a chave de API que está sendo resolvida não existe ou é inválida. A solicitação não deve ser tentada novamente sem modificar a chave de API. |
| api_url_invalid | Indica que o URL da API que está sendo endereçado é inválido. A solicitação não deve ser tentada novamente sem modificar o URL da API. |
| title_invalid | Indica que o título, que é um valor obrigatório, não foi enviado ou não está dentro das restrições de caracteres. |
| link_invalid | Indica que o link, que é um valor obrigatório, não foi enviado ou não está dentro das restrições de caracteres. |
| mimeType_invalid | Indica que o mimeType, que é um valor obrigatório, não foi enviado ou não está dentro das restrições de caracteres. |
| id_invalid | Indica que o ID, que é um valor obrigatório, não foi enviado ou não está dentro das restrições de caracteres. |
O Enterprise Search usa integrações de terceiros para implementar uma "pesquisa federal". As pesquisas no menu da área de trabalho são suportadas por um mecanismo de PNL e um banco de dados gráfico que oferece suporte a uma ótima experiência do usuário.
O menu da área de trabalho Enterprise Search não indexa dados de terceiros em um banco de dados pesquisável de forma independente.
O diagrama de sequência abaixo descreve o algoritmo de pesquisa:
Para garantir que a integração do menu do desktop do ServiceNow funcione corretamente, os clientes precisam permitir a listagem dos seguintes IPs: