Solicitação da Web - BETA
Use o estágio Solicitação da Web para recuperar informações para usar em um bot ou gerar alterações em um sistema externo. O estágio é executado na Ivanti Neurons Platform, uma vez por dispositivo que passa pelo estágio. Ele pode interagir com APIs REST de terceiros e é compatível com APIs autenticadas e não autenticadas.
Como configurar o estágio Solicitação da Web
- Na página Criar bot, adicione o estágio Solicitação da Web a um bot e abra as Configurações do estágio.
- No menu suspenso Selecionar credencial, selecione a credencial se a solicitação da web exigir autenticação. Caso precise criar novas credenciais, clique em Adicionar credenciais para abrir o Repositório de credenciais . Atualmente, aceitam-se autenticações por chave de API e API básica. Se nenhuma credencial for necessária, deixe a configuração padrão Sem autenticação.
- Em Cabeçalhos, alterne Mostrar cabeçalhos gerados automaticamente para Ligado se quiser visualizar os cabeçalhos gerados automaticamente. Os cabeçalhos seguem os requisitos da API de destino. Para mais detalhes, consulte a documentação do terceiro.
- Chave: insira a chave do cabeçalho da solicitação da web.
- Valor: insira o valor do cabeçalho da solicitação da web.
- Selecione o Método. Esse é o método HTTP que será usado para acessar a API de destino. Os métodos aceitos são: GET, POST, PUT, PATCH e DELETE.
- Insira o Endereço da API. O endereço deve ser acessível pela Internet.
Se você estiver passando valores oriundos de outro estágio ou de uma entrada de bot e a API de destino aceitar carga JSON, clique em Editar corpo JSON para abrir o editor de JSON. Selecione os valores que deseja incluir (o estágio Solicitação da Web deve estar conectado aos estágios anteriores para que as informações sejam transmitidas). - Escolha o Modo de saída apropriado para refletir a resposta da API. Se o método HTTP escolhido foi GET, o mais comum será JSON.
- Clique em Testar e obter resposta para fazer uma chamada imediata à API.
Se o corpo JSON contiver variáveis de estágios anteriores, você será solicitado a inserir dados de exemplo. - A Resposta de exemplo é preenchida a partir da ação Testar e obter resposta.
Depois de verificar a resposta, você pode determinar se os resultados são singulares (campos exclusivos para cada ponto de extremidade) ou uma matriz (múltiplos valores para determinado campo em cada ponto de extremidade). - Se os resultados forem uma matriz, você precisará ativar a Matriz de mapeamento.
Quando o estágio estiver no modo de matriz de mapeamento, ele exibirá o emblema "múltiplo", o que significa que para usar os resultados na maioria dos outros estágios você precisará usar um bloco for-each (para-cada) para executar o conteúdo de cada resultado.- Insira o Caminho até matriz.
- Assim que Matriz de mapeamento estiver Ligada, preencha os seguintes atributos em Mapa de campos:
- Caminho dentro do elemento da matriz: caminho para o objeto na resposta JSON. Pode ser o próprio nome, mas, se o objeto estiver aninhado, será preciso denotar o caminho em sintaxe de ponto, por exemplo, nível1.nível2.meucampo
Exemplo singular:
{"configuration": {startup_events": {"updates": "algum valor"}}}
O caminho para atualizações seria: configuration.startup_events.updates
Exemplo matriz:
{"users": [{display_info": {"name": "John"}}]}
O caminho da matriz seria: users
O caminho dentro da matriz seria: displayinfo.name - Tipo: Precisa corresponder ao formato do valor que está sendo lido para que os filtros/comportamento corretos possam ser aplicados em estágios futuros.
- Rótulo mapeado: nome amigável do campo que aparecerá no seletor de token e nos filtros em estágios subsequentes.
- Caminho dentro do elemento da matriz: caminho para o objeto na resposta JSON. Pode ser o próprio nome, mas, se o objeto estiver aninhado, será preciso denotar o caminho em sintaxe de ponto, por exemplo, nível1.nível2.meucampo
Depois que os atributos da matriz de mapeamento forem selecionados, clique em Testar mapeamento para testar os mapeamentos em relação à resposta de exemplo, isso garante que os mapeamentos estejam corretos.