Casos de uso comuns API

Sobre casos de uso de API

Esta página destaca as maneiras pelas quais outros clientes da Qualtrics estão aproveitando a API da Qualtrics. Abaixo, você encontrará uma lista de solicitações comuns API que nossos clientes estão usando e os casos de uso associados a cada solicitação.

Métodos comuns

Página serviço

A automação da construção de solicitações API geralmente é feita por um especialista em TI em sua organização, pois esse processo exige a implementação de código personalizado. Em alguns casos, porém, é possível usar uma pesquisa Qualtrics para automatizar em vez de código personalizado. As etapas abaixo demonstram como realizar esse processo.

Siga as etapas abaixo depois que seu pesquisa tiver sido construído:

1. Navegue até a guia Pesquisa e abra o Pesquisa Flow.
   
2. Clique em Adicionar abaixo ou Adicionar um novo elemento aqui.
3. Selecione Web Service.
4. Insira o URL da solicitação de API da seção Definição da documentação.
   
5. Selecione o método que deseja usar (ou seja, GET, PUT, POST ou DELETE).
   Atenção: Embora o PATCH esteja disponível no elemento Web Service, ele não pode ser usado com a API do Qualtrics.
6. Clique em Adicionar um cabeçalho personalizado para enviar ao serviço da Web.
7. Digite X-API-TOKEN no campo Header to Web Service e seu token no campo Value.
   
8. Adicione todos os parâmetros de cabeçalho necessários para sua solicitação de API clicando no sinal de mais(+).
9. Se você tiver definido o Method como POST ou PUT, clique em Add a body parameter to send to web service e insira todos os parâmetros e valores necessários.
10. Defina o valor de cada parâmetro à sua direita.
    Qdica: Você deve usar o Piped Text para valores com dados dinâmicos, como Nome, Sobrenome e E-mail.

    

11. Se estiver usando API v2.x no elemento Web Service, será necessário clicar em Add a query parameter to send to web service para adicionar os parâmetros e valores de URL para as solicitações.

JSON

Você pode passar seus parâmetros como JSON por meio do corpo da solicitação. Observe que, ao usar esse método, você deve especificar um Content-Type (ou seja, application/json ou text/json). Esse método geralmente é realizado por um especialista em TI em sua organização, pois esse processo exige a implementação de código personalizado.

Cadeia de consulta

URL raiz

api

o primeiro parâmetro adicionado ao URL raiz, inclua um “?” seguido do nome do parâmetro, um sinal de igual e o valor do parâmetro (por exemplo, ?Version=2.4). Adicione todos os parâmetros subsequentes com um “&” à frente (por exemplo, &Request=importPanel).

URL raiz + parâmetros obrigatórios:

https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?Version=2.4&Request=importPanel
&User=kathleenb_gen&Token=12345678901234567890&Format=XML

Continue adicionando ou acrescentando quaisquer outros parâmetros adicionais ao seu URL seguindo o mesmo processo descrito acima. Depois de incluir todos os parâmetros desejados, você terá uma solicitação concluída.

URL raiz + parâmetros obrigatórios + parâmetros adicionais:

api Request=importPanel
&User=kathleenb_gen&Token=12345678901234567890&Format=XML
&LibraryID=UR_12345678901234567890&ColumnHeaders=1&Email=3&URL=https%3A%2F%2Fco1.qualtrics.com
%2FWRQualtricsControlPanel%2FFile.php%3FF%3DF_3IeSPPh9HjXwaj3%26download%3D1&Name=Test
&FirstName amp;LastName amp;AllED=1

Você pode encontrar mais informações sobre cadeias de consulta em nossa página de suporte Passando informações por meio de cadeias de consulta.

Plataforma de pesquisa

Automatização da importação de uma lista de contatos

Você pode usar a solicitação Criar importação de contatos para importar lotes de contatos para sua conta Qualtrics. Por meio dessa solicitação, você pode importar listas JSON de indivíduos do seu CRM para o Qualtrics. Esses contatos podem ser importados carregando um arquivo JSON e definindo o parâmetro de cabeçalho Content-Type como multipart/form-data, ou incluindo os contatos no corpo da solicitação e definindo o Content-Type como application/json.

Automatização da criação de um contato

Em vez de atualizar manualmente as listas de contato com novos membros, você pode automatizar o processo usando a solicitação Criar Contato. Essa solicitação adiciona um novo contato a uma lista de contatos existente. Para essa solicitação, você precisará do ID Lista discussão e de quaisquer outros campos que queira adicionar ao contato. Eles precisarão ser passados pelo corpo da solicitação, definindo Content-Type como application/json.

Geração de seus próprios links individuais

Talvez seja necessário distribuir o pesquisa por meio de uma mala direta interna, em vez da mala direta do Qualtrics. Com a API do Qualtrics, é possível criar Links individuais que rastreiam as informações pessoais de um respondente sem precisar usar o mailer do Qualtrics.

Para realizar essa tarefa, você precisará usar duas solicitações API: Criar Distribuição e Links Distribuição. Antes de começar, você precisará importar uma lista de contatos para o Qualtrics manualmente ou usando a solicitação API Create Contacts Import.

Os parâmetros de interesse para a solicitação Criar Distribuição e links Distribuição são:

• ID Lista mala direta (cada distribuição está vinculada a uma lista de destinatários)
• ID da pesquisa
• Descrição (o nome da distribuição)
• Ação (o valor aqui precisa ser CreateDistribution)

Automatizar o download de dados em preparação para a importação em seu CRM

Se você precisar de dados de muitas pesquisas diariamente, poderá usar nossa API para obter respostas. A API v3 usa uma série de três solicitações para obter dados:

• Criar exportação de respostas: Essa solicitação inicia o processo de exportação e é usada para especificar o formato do arquivo e outras preferências. Isso retornará uma ID de exportação de resposta.
• Obter o progresso da exportação de respostas: Essa solicitação é usada para verificar o andamento da exportação usando a ID de exportação de resposta fornecida na primeira solicitação. Quando o percentComplete chegar a 100, você poderá usar a última solicitação para obter o arquivo.
• Obter arquivo de exportação de respostas: Quando o arquivo estiver pronto, você poderá usar essa solicitação para fazer o download. Ele será exportado como um arquivo compactado. Observe que, embora a maioria das solicitações API funcione quando a ID do datacenter não estiver correta no URL, essa solicitação não funcionará. Certifique-se de usar o ID correto do datacenter nessa solicitação.

Essa sequência de solicitações faz o download dos seus dados dados brutos, facilitando a obtenção dos dados e a importação dessas respostas para o seu CRM, data warehouse etc.

Diretório XM

Atualização de um contato (Lista Diretório Contacts e Update Diretório Contato)

Às vezes, você pode querer atualizar um contato por meio da API. Para isso, você precisará do ID Contato do contato. A solicitação API Lista Diretório Contacts permite que você procure o ID de Contato de um contato, que pode ser usado em solicitações API posteriores. Primeiro, explicaremos a solicitação de API Lista Diretório Contacts e, em seguida, Update Diretório Contato.

Tudo o que você precisa para a solicitação Lista Diretório Contacts é o Diretório ID. O resultado da solicitação Lista Diretório Contacts será o recebimento do ID do Contato para que você possa usá-lo em solicitações como Update Diretório Contato.

Há, então, dois parâmetros principais de interesse para a solicitação Update Diretório Contato: ID Diretório e ID Contato. Como resultado da solicitação Update Diretório Contato, o contato especificado será atualizado com as informações que você alterou com base nos parâmetros da sua solicitação.

Guias de soluções API

É possível encontrar vários guias de solução para Gerenciar questionários, Gerenciar usuários, Gerenciar grupos de usuários e Obter Respostas Pesquisa em nosso site de documentação da API v3.