Qualtrics Platform
Customer Journey Optimizer
XM Discover
Qualtrics Social Connect

Usando a documentação da API da Qualtrics

Sobre a documentação da API

Nossa página de documentação da API da Qualtrics detalha toda a documentação disponível atualmente.

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

Visão geral

Na Visão geral da API, você pode ver informações sobre a API da Qualtrics em geral, bem como informações sobre paginação (ou seja, se você executar uma solicitação Listar contatos e tiver mais de 100 contatos, o resultado será paginado e um URL nextPage será fornecido para obter os próximos 100 – isso se aplica a todas as solicitações de coleta).

Servidores Qualtrics da lista de permitidos

Consulte Lista de permitidos de servidores Qualtrics.

URL base e IDs do centro de dados

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

Localizando seus IDs do Qualtrics

Esta subseção mostra onde você pode encontrar os vários IDs de que precisará ao executar solicitações de API. Para IDs que não estão disponíveis nesta seção, consulte Localizando IDs da 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 mais informações sobre o processo de autenticação, consulte Gerando um token de API.

Parâmetros

A subseção Parâmetros abrange os diferentes métodos de transferência de parâmetros, dependendo do método HTTP utilizado (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 motivos possíveis 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.

Qdica: Se você não vir Respostas ou Atualizando a partir de versões anteriores como opções na documentação do, certifique-se de selecionar Exibir todas as 7 na parte inferior da lista da seção API.

Uso das APIs do Qualtrics

Esta seção da documentação tem snippets de código em Python e Java para ajudar você a desenvolver fluxos de trabalho para gerenciar pesquisas e usuários e obter resultados da pesquisa.

Aviso: os recursos de codificação personalizada são fornecidos como estão e podem exigir conhecimento de programação para implementação. Nossa equipe de suporte não oferece assistência nem consultoria em codificação personalizada. Ao invés disso, você pode perguntar para nossa comunidade de usuários dedicados. Se você quiser saber mais sobre nossos serviços de codificação personalizada, entre em contato com o seu Executivo de contas da Qualtrics.

Referência

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

Solicitações

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

Organizações
Divisões
Grupos
Usuários
Pesquisas
Exportando respostas da 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 de API tem um nome, uma breve descrição, uma tabela que lista possíveis parâmetros, a resposta, um exemplo de solicitação em cURL e o assistente “Experimentar”. Entender como usar essas informações pode ajudar a otimizar seu trabalho.

Nome, descrição e URL

As primeiras 3 coisas listadas para qualquer solicitação de API são o verbo HTTP, o nome da solicitação de API e uma descrição breve da solicitação.

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

Observe a estrutura expandida utilizada nos URLs. Por exemplo:

A solicitação de listas de destinatários de lista utiliza 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 listar os contatos nessa 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 de API, você verá uma tabela listando todos os parâmetros do corpo possíveis que podem ser usados (alguns serão opcionais, alguns serão obrigatórios). Esta tabela tem 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

Atenção: todos os nomes e valores de parâmetro diferenciam maiúsculas de minúsculas.

Amostra de solicitação

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

Qdica: Observe que como os IDs são apenas exemplos e não IDs reais, as solicitações nos exemplos não funcionarão, mas você pode simplesmente substituí-los por IDs de sua própria conta.

Exemplo de resposta

Esta seção fornece um exemplo do que você pode esperar receber assim que sua solicitação de API for efetuada com êxito. Por exemplo, se você estiver usando a solicitação de API Criar usuário, sua resposta será o ID de usuário do usuário recém-criado.

Concluindo solicitações de API no site da API

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

Atenção: ter cuidado ao testar APIs. Se você inserir o mínimo de informações necessárias para executar uma chamada de API, essa janela modal completará sua solicitação de API. Os campos obrigatórios variam de acordo com a chamada da API e serão listados na página da chamada.

Selecione entre Chave API e OAuth 2.0.
Insira o token de API da sua conta no campo Token da API. (Ou as informações OAuth 2.0 correspondentes, se você tiver escolhido OAuth 2.0.)
Insira quaisquer parâmetros adicionais.
Clique em Usuários para escolher um servidor no qual testar. Para o teste mais preciso, você deseja que isso corresponda ao centro de dados da sua conta do.
Pressione Enviar solicitação de API para testar a chamada API.

Qdica: Para saber quais valores são aceitáveis para cada parâmetro, consulte a tabela de parâmetros para a solicitação. Você também pode consultar o exemplo cURL na documentação.

Depois de inserir os valores necessários para sua solicitação, você verá a saída da chamada em “Resposta”.

Atenção: algumas solicitações não funcionam com esta função de teste. Isso será indicado na página para a solicitação.

Muitas das páginas neste site foram traduzidas do inglês original usando tradução automática. Embora na Qualtrics tenhamos feito nossa diligência prévia para obter as melhores traduções automáticas possíveis, a tradução automática nunca é perfeita. O texto original em inglês é considerado a versão oficial, e quaisquer discrepâncias entre o inglês original e as traduções automáticas não são juridicamente vinculativas.