Perguntas frequentes sobre API do Social Connect

Geral

Como ativo minha conta de desenvolvedor?

Para acessar a API e as funcionalidades relacionadas, você deve primeiro ativar a conta de desenvolvedor. Consulte Preferências de configurações pessoais para obter mais informações.

Como posso começar a usar a API do Social Connect?

Consulte o guia passo a passo da API do Qualtrics Social Connect.

Que tipo de conta eu preciso para usar a API do Social Connect?

O acesso à API não está incluído em todos os planos de preços. Entre em contato com o suporte se tiver perguntas sobre o que está incluído em sua licença.

Você tem uma biblioteca cliente na linguagem de programação x?

A Qualtrics não oferece bibliotecas clientes, mas existem bibliotecas para o protocolo OAuth em quase todos os idiomas. Consulte http://oauth.net/code/.

Posso testar a API rapidamente?

Você pode testar a API por meio do console da API. Aqui, você selecionará um ponto de acesso e preencherá os parâmetros necessários. Um resultado imediato será exibido para você ver se a API resultou em seu resultado desejado.

Você pode aumentar os limites de taxa de API?

Consulte Limites de taxa para obter uma visão geral dos limites de taxa da API. Nossos limites de taxa atual são mais do que suficientes para casos de uso padrão. No entanto, se você precisar de limites de taxa extras, entre em contato com o suporte e descreva o caso de uso do seu aplicativo e os limites de taxa solicitados.

Como funciona a filtragem na API?

Vários pontos de acesso da API do Social Connect permitem que você transfira um parâmetro de cadeia de filtro.

Por exemplo, digamos que você está buscando uma lista de menções. Você pode filtrar as menções de modo que somente as menções com um determinado tag sejam retornadas.

O parâmetro de filtro é sempre uma cadeia. Sua sintaxe suporta a pesquisa de várias propriedades dos dados (palavras mencionadas, tags, status, tempo de resolução, …) e combiná-las usando uma sintaxe booleana e aninhada.

Quando você cria um filtro na plataforma Social Connect, o filtro tem uma representação textual associada. Essa representação será exibida na janela de filtro depois que você selecionar seus campos de filtro. Você pode copiar este parâmetro para depois usar em suas chamadas API.

Qual método é usado para assinar webhooks?

Consulte Webhooks para obter mais informações.

Por que estou limitado a 20 chamadas de API por hora?

Se estiver usando o console de API, o limite de taxa é de 20 chamadas autenticadas por hora, em vez das chamadas padrão de 350 por hora para outros clientes de API. Se você estiver enfrentando esse limite de 20 chamadas, certifique-se de que está usando o token de acesso para seu aplicativo de API, não o Console da API.

Autenticação API

Como as chamadas de API são autenticadas?

A Qualtrics usa o protocolo OAuth 2.0 padrão. Consulte Autenticação para mais informações.

Preciso realmente implementar o OAuth para o meu aplicativo?

Se você não precisar que os usuários do seu aplicativo autentiquem a conta do Qualtrics Social Connect, gere um token OAuth para sua própria conta de usuário. Vá para a visão geral do aplicativo, clique em Editar ao lado do aplicativo registrado, vá para a guia Tokens de acesso. Se você clicar em Autorizar eu mesmo, será gerado um token de acesso para seu usuário conectado atual (com suas permissões). Você pode usar este token de acesso para assinar solicitações de API.

Por quanto tempo os tokens de acesso são válidos?

Consulte a página Autenticação para mais informações.

Quais contas e dados posso acessar com um token?

Um token de acesso OAuth é gerado para um usuário específico do Social Connect. Este usuário tem acesso a uma ou mais contas (você pode ver quais através do endpoint `/me/account`). Os dados que você pode acessar dependem de quais contas o próprio usuário tem acesso e qual é a função dele nessa conta.

Trabalhando com menções

Como obtenho menções da minha caixa de entrada do Social Connect na minha própria aplicação?

Use o endpoint `/{account_id}/Inbox/mentions` para recuperar todas as menções em qualquer um dos seus tópicos. Esta página de suporte da API cobre quais informações são recuperadas para suas menções.

Você também pode criar um workflow para chamar Web hooks em sua aplicação utilizando a funcionalidade de receita de automação do Social Connect.

Por que os Tweets são retornados pela API sem detalhes?

Para Tweets, a Qualtrics só pode retornar os dados específicos do Social Connect e o ID do Twitter Tweet. Esta é uma restrição dos Termos de API do Twitter.

Como você tem o ID do Tweet, pode acessar a API do Twitter e utilizar o ponto de extremidade “/status/lookup” para buscar todos os detalhes.

Por que alguns posts do Facebook são anônimos?

Publicações públicas do Facebook (escolhidas pelo Social Connect por meio de sua pesquisa por palavra-chave, não mensagens em suas páginas do Facebook) são anonimizadas. Esta é uma limitação da API do Facebook.

Posso adicionar minhas próprias mensagens ao Social Connect?

Se você tiver um formulário de contato ou fórum interno que gostaria de ver monitorado pelo Social Connect, você pode ligar para o ponto de acesso “/{account_id}/Inbox/add” para adicionar suas mensagens personalizadas ao Social Connect. Essas mensagens estarão acessíveis em sua caixa de entrada e insights.

Mensagens adicionadas ao Social Connect por meio da API não podem ser respondidas a partir do Social Connect Se você quiser ter essa integração mais estreita com seu sistema personalizado, entre em contato com o suporte.

Posso exportar casos por meio da API?

Você pode usar o ponto de extremidade de menção regular (exportar lista/atualizar menção única) para exportar casos. Se você só quiser devolver casos em sua solicitação, pode utilizar o filtro ‘sub_category:case’.

Qual é a diferença entre casos e menções para a API?

No Social Connect, uma “menção” é o objeto central de uma mensagem (um único tweet, uma única mensagem privada, um único comentário). Há também o conceito de um “Caso” que basicamente é uma coleção de menções.

O principal uso para casos é agrupar várias mensagens de um determinado usuário e respostas de agentes em conversas.

De uma perspectiva técnica, uma “conversa de caso” consiste em:

• O próprio caso (que também é um objeto de menção).
• Um caso pode ter rótulos, um status, um título, etc.
• Uma lista de menções que fazem parte da conversa.
• As menções que foram agrupadas no caso.

Consulte esta página de suporte da API para obter mais informações sobre casos e menções.

Posso importar mensagens para a caixa de saída do Social Connect?

Você pode criar rascunhos de novas publicações para que gerentes sociais verifiquem, editem e publiquem por meio do ponto de acesso “/{account_id}/editor/add”.

Posso editar uma menção por meio da API?

Você pode processar menções existentes utilizando o ponto de acesso “/{account_id}/caixa de entrada/menção/{topic_id}/{id}”. A documentação para este ponto de extremidade tem exemplos para atualizar as tags de uma menção, adicionar uma nota e muito mais.

Como excluo todos os dados de um determinado usuário no Engage por meio da API?

Se você quiser eliminar todos os dados de um determinado cliente que está em sua conta do Social Connect, precisa eliminar dois tipos de dados:

1. Todas as menções desse usuário no sistema
2. Qualquer informação sobre esse usuário que esteja armazenada no Social Connect CRM.

Para encontrar todas as menções de um determinado usuário, utilize o ponto de acesso “/{account_id}/Inbox/mentions” e filtre por um determinado AuthID, por exemplo. “auth.id:123”.Assim que você tiver essa lista de menções, as menções podem ser excluídas por meio do ponto de acesso “/{account_id}/Inbox/reference/{topic_id}/{id}” .

Para saber se seus agentes gravaram ou não mais dados de contato no Social Connect CRM para um contato, efetue uma solicitação GET para “/{account_id}/Inbox/contact/{service}/{service_id}”. Se o objeto de resposta contiver um contact.id, isso significa que existe um contato para esse usuário. Se a resposta não contiver uma propriedade contact.id, isso significa que não foram armazenados dados no Social Connect CRM.

Assim que você tiver um contact.id, pode efetuar uma solicitação DELETE para o ponto de acesso /{account_id}/Inbox/contact/{contact_id} para remover todas as informações.

Trabalhando com contatos  ​

Como posso encontrar detalhes de contato de uma menção ou caso?

Se uma menção ou um caso for retornado pela API, ele conterá uma lista de objetos “action_link”. Os links de ação contêm informações para o objeto atual sobre quais outros pontos de acesso de API ou URLs na aplicação Web são relevantes para este objeto. Para menções e casos, um dos links de ação incluídos é onde você pode chamar os detalhes de contato do autor da menção ou do caso.

Ao usar o ponto de acesso /{account_id}/Inbox/cases, o objeto de contato do autor da menção é incluído por padrão. A Qualtrics não inclui o objeto de contato completo para menções, mas por meio dos links de ação, esse objeto pode ser buscado fazendo uma chamada de API separada.

Editoração

Posso usar a API Clarabridge Engage para publicar em um canal social?

Não, a API não permite a publicação direta para plataformas de terceiros. Isso significa que você não pode utilizar a API do Social Connect para publicar um tweet ou um comentário do Facebook.

No entanto, você pode utilizar o API do Social Connect para criar esboços ou mensagens em fila para aprovação. Estes serão então publicados quando aprovados ou publicados através da interface do Social Connect. O ponto de acesso para rascunhar mensagens é /{account_id}/editor/add.

Gerenciamento de usuários

Posso alterar o status dos usuários por meio da API?

Não, você não pode modificar o status de usuários via API. Embora você não possa modificar o status, pode modificar o Nome, a Empresa, o E-mail, o Avatar e a Programação do horário comercial por meio do ponto de acesso /{account_id}/settings/user/{id}.

Posso modificar a função de usuário de usuários por meio da API?

É possível modificar a função de usuário de um usuário por meio de nossa API. No entanto, por motivos de segurança, não é possível alterar uma função de usuário para Administrador. Todas as outras funções de usuário estão disponíveis para modificação por meio do ponto de acesso /{account_id}/settings/user/{id}.

Posso criar novos usuários por meio da API?

Por motivos de segurança, isso não é possível via API.

Trabalhar com perfis sociais

Posso recuperar informações sobre os perfis sociais em meus tópicos?

Você pode buscar informações sobre um determinado perfil social por meio do ponto de acesso “/{account_id}/Inbox/contact/{service}/{service_id}”. Isso incluirá todos os detalhes que você preencheu para essa pessoa no Social Connect CRM, como sexo, e-mail ou atributos personalizados que você adicionou para este usuário.

Trabalhando com insights

Posso obter estatísticas de Clarabridge Engage?

Você pode extrair dados do Insights usando 2 pontos de acesso de API diferentes;

1. O ponto de acesso “/{account_id}/dashboards/export/{dashboard_id}” retorna os dados de todos os widgets em um determinado dashboard. Assim que você ou seus usuários tiverem configurado dashboards personalizados, você pode usar este ponto de acesso para obter os dados por trás deles.
2. O ponto de extremidade “/{account_id}/insights/facets” atua como o equivalente de API do recurso Gerador de gráficos no Social Connect.

Problemas

Onde posso encontrar o ID da minha conta?

Depois de autenticar, você pode obter uma lista de todas as contas (e seus IDs) às quais um usuário tem acesso por meio do ponto de acesso “/me/contas”.

Onde posso encontrar meu ID de tópico?

Depois de autenticar, você pode obter uma lista de todos os tópicos (e seus IDs) aos quais um usuário tem acesso por meio do ponto de acesso “/me/contas”.

Onde posso encontrar meu ID de usuário?

Depois de autenticar, você pode obter detalhes sobre o usuário autenticador (incluindo o respectivo ID) por meio do ponto de acesso “/me”.