Qualtrics Platform
Customer Journey Optimizer
XM Discover
Qualtrics Social Connect

Introdução à API da Qualtrics

Sobre a API da Qualtrics

A API da Qualtrics pode ser usada para automatizar processos repetitivos dentro da Qualtrics ou transmitir informações para dentro e para fora da Qualtrics. Por exemplo, um Administrador da marca pode usar a API da Qualtrics para automatizar o processo de criação de conta em vez de criar centenas de contas individualmente. Da mesma forma, um usuário pode automatizar a criação da lista de contatos em vez de compilar e importar manualmente listas de contatos. A Qualtrics também tem vários Guias de solução de API que podem ajudá-lo a determinar a melhor forma de usar a API de acordo com suas necessidades.

Atenção: as extensões da API podem exigir conhecimento de programação para serem implementadas. 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.

Acesso à API para diferentes produtos

A Qualtrics possui uma variedade de produtos diferentes que permitem coletar dados práticos em tempo real. Alguns desses produtos incluem a Plataforma de Pesquisa, o Site Intercept e o XM Directory (Público-alvo). Depois de adquirir o recurso da API da Qualtrics, você poderá usar a API para qualquer produto que faça parte da sua licença.

Aqui estão os links para a documentação da versão mais recente da API para cada um de nossos produtos:

Para as APIs mais recentes para a maioria dos produtos, consulte API da Qualtrics
Site Intercept

Observe que sempre recomendamos que nossos clientes usem a versão mais recente da API.

Compreendendo a API da Qualtrics v3

A API da Qualtrics v3 é uma API REST que permite que você se comunique ou consulte nosso sistema usando uma sintaxe de URL simples. A comunicação com o sistema Qualtrics pode ser pensada como uma sequência de solicitações. Você pode solicitar que as informações sejam enviadas à Qualtrics, atualizadas, removidas ou devolvidas ao seu sistema. Essas solicitações podem ser feitas por solicitações GET, POST, PUT ou DELETE, que retornam respostas JSON.

Por esses meios, a API Qualtrics permite que você interaja com partes do sistema Qualtrics e integre essas áreas ao seu CRM.

Introdução

Para obter informações sobre como começar a usar a API Qualtrics, consulte Qualtrics API Quickstart.

Parâmetros de transferência

Os parâmetros são os blocos de construção das suas solicitações. Cada solicitação de API requer que vários parâmetros globais sejam passados para a Qualtrics, bem como mais parâmetros específicos da solicitação e alguns opcionais.

Você sempre precisará passar o token de API pelo cabeçalho da solicitação como X-API-TOKEN. Dependendo da solicitação específica em execução, pode ser necessário passar outros parâmetros pelo cabeçalho, pela URL ou pelo corpo da solicitação. Ao passar parâmetros pelo corpo da solicitação, você precisa enviar os parâmetros como JSON. Ao usar esse método, você deve especificar um tipo de conteúdo (por exemplo, aplicativo/json ou multiparte/dados de formulário).

Exemplo: no exemplo de POST a seguir, em cURL, especificamos o URL base, o tipo de conteúdo e o token no cabeçalho. O ID da pesquisa e o formato da exportação são indicados no
body.curl -X POST -H 'X-API-TOKEN: yourapitokenhere' -H 'Content-Type: application/json' -d '{ "SurveyId": "SV_012345678912345", "format": "csv" }' 'https://yourdatacenterid.qualtrics.com/API/v3/responseexports'

Gerando um token de API

Será necessário um token de API para acessar a API da Qualtrics. Cada usuário em uma licença deve gerar seu próprio token de API. O token de API da sua conta é necessário para autenticar cada solicitação de API que você cria. Seu token é usado no lugar da senha da sua conta e ajuda a melhorar a segurança do seu trabalho. Para autenticar, inclua seu token no cabeçalho HTTPS X-API-TOKEN.

Qdica: Para gerar um token, o usuário deve ter a permissão de API de acesso ativada para sua conta. Se sua organização não tiver acesso ao recurso da API Qualtrics, entre em contato com o Executivo de Contas da Qualtrics para obter mais informações.

Para gerar um token de API

Clique no ícone de configurações do usuário no canto superior direito da sua conta.
Clique em Configurações da conta.
Clique em IDs da Qualtrics na barra de navegação.

Atenção: as configurações da conta foram remodeladas. Para visualizar os IDs da Qualtrics, clique em Alternar para a versão mais antiga.
Na caixa API, clique em Gerar token.

Aviso: não clique em Gerar token se você já tiver um token. Seu token de API só pode ser gerado uma vez. Se você gerar um novo token e tiver extensões existentes que utilizam o token antigo, essas extensões existentes serão interrompidas. Gerar um novo token é irreversível; não é possível recuperar tokens anteriores.

Criação de uma chave secreta de client

Clique no ícone de configurações do usuário no canto superior direito da sua conta da Qualtrics.
Clique em Configurações da conta.
Navegue até os IDs do Qualtrics.

Atenção: as configurações da conta foram remodeladas. Para visualizar os IDs da Qualtrics, clique em Alternar para a versão mais antiga.
Escolha Gerenciador de clientes OAuth.
Clique em Criar cliente.
Inserir um nome de mandante.
Se desejar, insira um endereço de e-mail de contato.
Para Tipo de concessão, escolha Credenciais do cliente.
Clique em Criar cliente.
Anote o ID do cliente e a chave secreta do cliente e armazene-os em um local seguro.

Atenção: assim que sair desta janela, o segredo do cliente será irrecuperável. Se você perder ou esquecer sua chave secreta do cliente, precisará repetir o processo acima para gerar um novo.