Criar spoke e criar ações importando uma especificação de OpenAPI
Automatize uma integração e gere ações reutilizáveis importando uma especificação OpenAPI.
Antes de Iniciar
- Instale o app Spoke Generator do ServiceNow Store.
- Função necessária: administrador
Procedimento
-
Na tela Informações do spoke, especifique se deseja criar o spoke em um novo escopo ou em um escopo existente.
-
Se você optar por criar o spoke em um novo escopo, selecione uma imagem como o logotipo da sua integração e preencha os campos.
Aqui, vamos passar por uma integração com o Zoom como exemplo.
Campo Descrição Nome de spoke Nome para identificar o spoke personalizado. Descrição Descrição sobre o spoke personalizado. Nota:O valor do nome do escopo da aplicação está no formato: x_<company-code> _<spoke-name> _<spoke> . Por padrão, o<company-code> é, snc. Você pode configurar o código da empresa configurando o Valor da propriedade do sistema, glide.appcreator.company.code.
Este valor configurado é usado quando o valor Nome do escopo da aplicação é gerado.
-
Se você optar por criar o spoke em um escopo existente, selecione uma imagem como o logotipo da sua integração e preencha os campos.
Aqui, vamos passar por uma integração com a AWS como exemplo.
Campo Descrição Nome da aplicação Um nome ou escopo de aplicação existente. Nome do escopo da aplicação Nome do escopo que é preenchido automaticamente com base no nome da aplicaçãoselecionado. Descrição Descrição sobre o spoke personalizado.
-
Se você optar por criar o spoke em um novo escopo, selecione uma imagem como o logotipo da sua integração e preencha os campos.
-
Clique em “Continuar”.
Com base no nome e na descrição fornecidos, se houver spokes correspondentes na Store, os detalhes do spoke serão exibidos.
-
Selecione Especificação OpenAPI e clique em Continuar para importar uma especificação OpenAPI.
-
Na tela Importar nova origem de OpenAPI, execute uma destas duas etapas.
-
Se você quiser importar usando uma URL, selecione Importar da URL para o método de importação e especifique a URL em URL da OpenAPI.
-
Se você quiser importar manualmente usando o código JSON ou YAML, selecione Importar de JSON ou YAML manualmente para Método de importação e forneça o código em JSON ou YAML.
-
Se você quiser importar usando uma URL, selecione Importar da URL para o método de importação e especifique a URL em URL da OpenAPI.
-
Na tela Criar novo alias de conexão e credencial, preencha os campos e forneça as informações de alias.
Campo Descrição Nome da conexão e da credencial Nome para identificar o registro de alias de conexão e credencial. Modelo de configuração para autenticação Mecanismo de autenticação necessário para esta integração. Certifique-se de que o mecanismo de autenticação seja compatível com a origem da OpenAPI. Nota:O modelo de configuração é preenchido automaticamente com base na especificação OpenAPI que você forneceu. Você pode continuar com a opção padrão ou alterá-la de acordo com seus requisitos. -
Na mesma tela, preencha os campos para configurar o alias.
Campo Descrição Informação de conexão Nome da Conexão Nome para identificar o registro de conexão. URL de conexão URL base para se conectar à instância ou ao servidor de terceiros. Este URL é preenchido automaticamente com base na especificação OpenAPI que você forneceu. Informações de credencial Com base no modelo de configuração selecionado, os campos de credencial relevantes são exibidos. Forneça os valores necessários para configurar o registro de credencial. Se você quiser configurar o registro de alias mais tarde, clique em Fazer isso mais tarde.
-
Clique em Gerar operações.
Todas as operações que podem ser realizadas usando a especificação OpenAPI são listadas.
-
Selecione as operações necessárias.
Você pode pesquisar as ações necessárias inserindo o termo necessário na barra de pesquisa. As ações que correspondem ao termo de pesquisa especificado são exibidas.
-
Clique em Publicar.
Como alternativa, você também pode selecionar Salvar ações como rascunho para salvar as ações como rascunho, modificá-las de acordo com seus requisitos e publicá-las posteriormente.