Serviço Web

Sobre serviços da Web

Às vezes, convém incluir recursos mais complexos em sua pesquisa. Talvez você queira inserir os 10 principais títulos de um site de notícias em sua pesquisa ou automatizar uma segunda distribuição de pesquisa para ser enviada por e-mail aos entrevistados de uma primeira pesquisa exatamente 2 horas depois. Um serviço da Web permitiria que você fizesse isso apenas fazendo solicitações para um URL designado.

Adição de um serviço web

1. Ao editar sua pesquisa, clique no ícone Fluxo da pesquisa na barra de navegação esquerda.
   
2. Clique em Adicionar abaixo ou Adicionar um novo elemento aqui.
   
3. Selecione Serviço Web.
4. No campo URL, cole o URL do seu serviço Web externo.
   
   Qdica: Você pode usar texto transportado para passar informações da pesquisa para o URL do ponto de acesso por meio de cadeias de consulta.
5. Selecione um Método para seu serviço Web. Explicaremos mais sobre os diferentes métodos na seção abaixo.

Métodos

Nosso recurso de serviço web permite que você escolha entre uma série de métodos para solicitar informações de seu URL especificado.

Se você estiver usando nossas chamadas de API, a documentação informará qual método usar, conforme indicado na captura de tela abaixo.

Parâmetros

Existem atualmente 3 tipos de parâmetros que você pode anexar à sua solicitação.

1. Parâmetro de consulta: em vez de adicionar uma string de consulta ao final do URL do serviço web, coloque seus parâmetros de consulta aqui.
2. Parâmetro de corpo: este parâmetro não está disponível para solicitações GET ou DELETE. Ele vem com 2 opções de formatação:
   a) application/x-www-form-urlencoded: Em vez de inserir seus parâmetros de corpo na área especificada do Web Service, adicione-os como uma string de consulta no final do URL especificado.
   b) application/json: Insira suas chaves em Dot Notation. Por exemplo, nossa chamada de API pode solicitar que você especifique um cabeçalho[fromEmail]. Em Notação de ponto, isso se torna header.fromEmail.
   Atenção: cada chave e valor em um objeto JSON, bem como todos os elementos em uma matriz JSON (incluindo texto transportado), devem ter aspas duplas ao redor dele.
3. Cabeçalho personalizado: inserir cabeçalhos de URL aqui.
   Qdica: URLs de autenticação devem ser adicionados ao cabeçalho personalizado.

Se você estiver usando nossas chamadas de API, a documentação informará que tipo de parâmetros incluir. O exemplo abaixo fornece parâmetros do corpo a serem definidos.

Adição de parâmetros ao seu serviço Web

1. Selecione qualquer uma das 3 opções de Adicionar um parâmetro para enviar para o serviço da Web indicadas na seção anterior. No exemplo acima, estamos indicando os parâmetros de consulta.
2. Digite o nome do parâmetro na caixa Parâmetro para serviço Web à esquerda.
3. Digite o valor correspondente do parâmetro na caixa Valor à direita.
4. Clique no sinal de mais (+) à direita do parâmetro para adicionar outro.
5. Clique em Aplicar quando terminar.

Testar seus parâmetros

Depois de colar seu URL e configurar seus parâmetros, você pode testar seu URL para ver quais Campos você pode acessar.

1. Clique em Testar URL para ver quais informações você pode obter do serviço Web externo.
   
2. Selecione os campos que deseja usar ou registrar em sua pesquisa. O Nome do campo é exibido à esquerda e um Valor de exemplo correspondente é exibido à direita.
   
3. Clique em Adicionar dados integrados para adicionar os campos selecionados aos seus dados.
   Qdica: Você pode alterar os nomes de dados integrados associados aos campos do seu serviço Web na coluna Definir dados integrados. Os nomes de dados integrados estão à esquerda do sinal de igual (=), indicado por um ícone de ED verde. O lado direito não deve ser alterado. Os nomes que você definir à esquerda serão os nomes dos campos como aparecem nos seus dados.
4. Se você selecionar Incêndio e esquecimento, não salvará nenhum dos dados retornados da chamada do serviço Web. Esse recurso é útil quando você não precisa salvar os dados retornados.
   
   Qdica: Fogo e esqueça permite que sua pesquisa faça uma solicitação a um serviço da Web sem esperar por uma resposta. Isso significa que seus entrevistados poderão concluir a pesquisa completa sem qualquer atraso devido ao serviço da Web. Você pode usar essa opção se tiver uma solicitação de serviço da Web que demora algum tempo a processar, mas recomendamos que você só use esse recurso durante o teste, pois isso impedirá que os dados integrados sejam salvos.
5. Quando terminar, clique em Aplicar.

Correção de erros TLS

A partir de 1º de setembro de 2021, as solicitações de serviço da Web com erros Transport-Layer Security (TLS) falharão. TLS é o que torna as solicitações via Web mediante HTTPS (em oposição a HTTP simples) seguras, evitando que os dados de solicitação sejam visíveis para terceiros e assegurando que a solicitação é enviada para o destino correto. Ignorar erros TLS elimina efetivamente esses benefícios de segurança; essa alteração é um passo importante em nossos esforços contínuos para melhorar a segurança da plataforma Qualtrics.

Para resolver cada erro TLS, você precisa executar 1 das seguintes ações:

• Corrija o erro TLS. Devido à natureza dos erros TLS, nossa equipe de suporte não pode fornecer orientação específica sobre como fazer isso, mas seu administrador de rede saberá como corrigir o erro.
• Altere a solicitação do serviço da Web do elemento de fluxo a ser feita via HTTP, não HTTPS. Por exemplo, você poderia modificar o URL “https://example.com” para “http://example.com”. Se você optar por utilizar esta abordagem, você também deve garantir que o URL HTTP não redireciona para o URL HTTPS.
  Atenção: esta abordagem fará com que os dados de solicitação do serviço da Web sejam transmitidos sem criptografia.

Você pode verificar se seu elemento de Web Service está pronto para essa alteração usando o botão de teste ao lado do campo URL no elemento de fluxo. A visualização dos dados brutos na janela resultante, também exibida abaixo, não deve mostrar um erro.

Tipos de projetos nos quais este recurso está disponível

Desde que você tenha acesso aos Serviços Web como parte de sua licença, você pode adicionar um serviço da Web a qualquer tipo de fluxo de pesquisa do projeto. Isso inclui:

• Projetos de pesquisa
• Engajamento
• 360
• Ciclo de vida
• Pesquisa de funcionário ad hoc
• Pesquisa de satisfação
• Soluções XM
• Conjuntas
• MaxDiff