Usando a documentação API Qualtrics

Sobre a documentação API

Nossa página de Documentação API Qualtrics detalha toda a nossa documentação disponível no momento.

Esta página o orienta sobre como navegar em nossa documentação, descrevendo o que cada seção aborda e o que está disponível.

Visão geral

Na Visão geral API, você pode ver informações sobre a API Qualtrics em geral, bem como informações sobre Paginação (ou seja, se você executar uma solicitação Lista contatos e tiver mais de 100 contatos, o resultado será paginado e uma URL nextPage será fornecida para obter os avançar 100 – isso se aplica a todas as solicitações de coleta).

Servidores Qualtrics da lista de permissões

Consulte Permitir a lista de servidores Qualtrics.

URL de base e IDs de data center

Esta subseção mostra como encontrar o ID do datacenter que você precisará incluir no URL de base para suas solicitações API.

Como encontrar seus IDs Qualtrics

Esta subseção mostra onde você pode encontrar os vários IDs necessários para executar solicitações API. Para IDs que não estão disponíveis nesta seção, consulte Localizando IDs do Qualtrics inspecionando o elemento.

Autenticação

A subseção Autenticação descreve quais informações são necessárias para autenticar suas solicitações, bem como sugestões para proteger seu token de API. Para obter mais informações sobre o processo de autenticação, consulte Geração de um token API.

Parâmetros

A subseção Parâmetros abrange os diferentes métodos para passar parâmetros, dependendo do método HTTP que está sendo usado (GET, POST, PUT ou DELETE).

Respostas

A subseção Respostas contém exemplos dos diferentes códigos de resposta HTTP que podem ser retornados quando você executa uma solicitação, bem como os possíveis motivos para cada código de resposta. Nossa API sempre retorna respostas em JSON, exceto no caso da solicitação de exportação de resposta, em que o arquivo pode ser retornado em qualquer um de nossos formatos disponíveis.

Usando as APIs do Qualtrics

Esta seção da documentação tem trechos de código em Python e Java para ajudá-lo a desenvolver fluxos de trabalho para gerenciar pesquisas e usuários e para obter resultados pesquisa.

Referência

A seção Referência contém informações importantes sobre formatos aceitáveis de data e hora, códigos de idioma, limites de solicitações e detalhes sobre assinaturas evento. As assinaturas Evento permitem que você envie notificações para um URL de publicação quando ocorrer um evento (por exemplo, uma resposta sendo registrada).

Solicitações

Para ajudar a organizar a documentação e ajudar os usuários a encontrar as solicitações API que estão procurando, as solicitações são categorizadas da seguinte forma:

• Organizações
• Divisões
• Grupos
• Usuários
• Pesquisas
• Exportação de Respostas Pesquisa
• Respostas
• Importações de resposta
• Biblioteca de mensagens
• Biblioteca de gráficos
• Distribuições
• Contatos da Plataforma Insights
• Assinaturas de evento
• Diretório XM (público-alvo)

Parâmetros e opções de solicitação

Cada solicitação API tem um nome, uma breve descrição, uma tabela que lista os parâmetros possíveis, a resposta, um exemplo de solicitação em cURL e o assistente “Try It Out”. Entender como usar essas informações pode ajudar a otimizar seu trabalho.

Nome, descrição e URL

Os três primeiros itens listados para qualquer solicitação API são o verbo HTTP, o nome da solicitação API e uma breve descrição da solicitação.

O URL usado na solicitação (ou “definição”) será listado ao avançar do verbo HTTP.

Observe a estrutura de detalhamento usada nos URLs. Por exemplo:

• A solicitação Lista Mailing Lists usa o seguinte URL: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists
• Em seguida, você pode usar um ID retornado com essa solicitação para obter uma lista de destinatários específica, anexando o ID ao final do URL: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId
• Para lista os contatos dessa lista de destinatários, adicione contatos ao final: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts
• Para obter um contato específico, você pode usar um contactId retornado na solicitação anterior: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts/:contactId

Lista de parâmetros do corpo

Para cada solicitação API, você verá uma tabela que lista todos os parâmetros de corpo possíveis que podem ser usados (alguns serão opcionais, outros serão obrigatórios). Essa tabela contém as seguintes informações:

• Nome de cada parâmetro
• Os formatos aceitos para cada parâmetro
• Se o parâmetro é obrigatório
• Uma breve descrição do parâmetro

Solicitar amostra

O amostra solicitação fornecido na documentação mostra como formatar a solicitação no cURL. Essas solicitações incluem o URL raiz e todos os parâmetros necessários da tabela de parâmetros.

Exemplo de resposta

Esta seção fornece um exemplo do que você pode esperar receber quando a solicitação API for bem-sucedida. Por exemplo, se você estiver usando a solicitação de API Create User (Criar usuário), sua resposta será o ID do usuário recém-criado.

Conclusão de solicitações API no site API

Nossa documentação de API permite que você execute uma solicitação de API forma rápida e fácil. (Observe que a maioria das solicitações API exige IDs Qualtrics)

1. Selecione entre API Key e OAuth 2.0.
   
2. Digite o token de API de sua conta no campo Token de API. (Ou as informações correspondentes do OAuth 2.0, se você escolheu o OAuth 2.0)
3. Insira quaisquer parâmetros adicionais.
4. Clique em Usuários para escolher um servidor para o teste. Para que o teste seja mais preciso, você deseja que ele corresponda ao data center de sua conta.
5. Pressione Send API Request (Enviar solicitação de API ) para testar a chamada de API.

Depois de inserir os valores necessários para sua solicitação, você verá o resultado da chamada em “Response” (Resposta)