Perguntas frequentes sobre API do Social Connect

Geral

Como faço para ativar minha conta desenvolvedor?

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

Como faço para começar a usar a API do Social Connect?

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

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. Contato o Suporte se tiver dúvidas sobre o que está incluído na sua licença.

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

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

Posso testar rapidamente a API?

Você pode testar a API por meio do console API. Aqui, você escolherá um endpoint e preencherá os parâmetros necessários. Um resultado imediato será exibido para que você veja se a API resultou no resultado desejado.

Você pode aumentar os limites da taxa de API?

Consulte Limite de taxa para obter uma visão geral dos limites de taxa API. Nossos limites de taxa atuais são mais do que suficientes para casos de uso padrão. Se, no entanto, você precisar de limites de taxa adicionais, entre contato o Suporte e descreva o caso de uso do seu aplicativo e os limites de taxa solicitados.

Como a filtragem funciona na API?

Vários pontos de extremidade da API do Social Connect permitem que você passe um parâmetro de string filtro.

Por exemplo, digamos que você esteja obtendo uma lista de menções. Você pode filtro as menções para que apenas as menções com uma determinada tag sejam retornadas.

O parâmetro filtro é sempre uma cadeia de caracteres. Sua sintaxe suporta a pesquisa de várias propriedades dos dados (palavras mencionadas, tags, status, tempo de resolução, etc.) e a combinação delas 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 aparecerá na janela filtro depois que você tiver selecionado os campos filtro. Você pode copiar esse parâmetro para usá-lo em suas chamadas API.

Que método é usado para assinar webhooks?

Consulte Webhooks para obter mais informações.

Por que minha taxa está limitada a 20 chamadas API por hora?

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

Autenticação de API

Como as chamadas API são autenticadas?

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

Eu realmente preciso implementar o OAuth em meu aplicativo?

Se você não precisar que os usuários do seu aplicativo autentiquem a conta do Qualtrics Social Connect, poderá gerar um token OAuth para sua própria conta de usuário. Vá para a visão geral do aplicativo, clique em Editar avançar do seu aplicativo registrado e vá para a guia Tokens de acesso. Se você clicar em Authorise Myself (Autorizar a mim mesmo), será gerado um token de acesso para o seu usuário conectado no momento (com as respectivas permissões). Você pode usar esse token de acesso para assinar solicitações API.

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

Consulte a página Autenticação para obter 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. Esse usuário tem acesso a uma ou mais contas (você pode ver quais são elas por meio do ponto de extremidade `/me/accounts`). Os dados que você pode acessar dependem das contas às quais o próprio usuário tem acesso e da função de usuário nessa conta.

Trabalhando com menções

Como faço para transferir as menções da minha caixa de entrada do Social Connect para o meu próprio aplicativo?

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

Você também pode criar um fluxo de trabalho para chamar web hooks em seu aplicativo usando o característica de receita de automação do Social Connect.

Por que os Tweets retornados pela API não têm detalhes?

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

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

Por que algumas publicações do Facebook são anônimas?

As publicações públicas do Facebook (coletadas pelo Social Connect por meio de sua pesquisa de palavras-chave, não as mensagens em suas páginas do Facebook) são anônimas. Essa é uma limitação da API do Facebook.

Posso adicionar minhas próprias mensagens ao Social Connect?

Se você tiver um formulário contato ou um fórum interno que gostaria de ver monitorado pelo Social Connect, poderá chamar o endpoint “/{account_id}/inbox/add” para adicionar suas mensagens personalizadas ao Social Connect. Essas mensagens poderão ser acessadas em sua caixa de entrada e em seus insights.

As mensagens adicionadas ao Social Connect por meio da API não podem ser respondidas no Social Connect. Se 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ê quiser retornar apenas casos em sua solicitação, poderá usar 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 “Caso”, que basicamente é uma coleção de menções.

O principal uso dos 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 estojo (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 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 novos posts para que os gerentes sociais verifiquem, editem e publicar por meio do endpoint “/{account_id}/publisher/add”.

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

Você pode editar as menções existentes usando o ponto de extremidade “/{account_id}/inbox/mention/{topic_id}/{id}”. A documentação desse ponto de extremidade tem exemplos para atualizar as tags de uma menção, adicionar uma nota e muito mais.

Como faço para excluir todos os dados de um determinado usuário no Engage por meio da API?

Se quiser excluir todos os dados de um determinado cliente que estão em sua conta do Social Connect, você precisará excluir 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 CRM do Social Connect.

Para localizar todas as menções de um determinado usuário, use o ponto de extremidade “/{account_id}/inbox/mentions” e filtro por um determinado authorID, por exemplo, “author.id:123”.

Para saber se seus agentes salvaram ou não mais dados contato no CRM do Social Connect para um contato, faça uma solicitação GET para “contato”. Se o objeto de resposta contiver um contato.id, isso significa que há um contato para esse usuário. Se a resposta não contiver uma propriedade contato.id, isso significa que nenhum dado foi armazenado no CRM do Social Connect.

Quando tiver um contato.id, você poderá fazer uma solicitação DELETE para o ponto de extremidade contato para remover todas as informações.

Trabalho com contatos ​

Como posso encontrar detalhes 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 Endpoints API ou URLs no aplicativo da Web são relevantes para esse objeto. Para menções e casos, um dos links de ação incluídos é onde você pode obter os detalhes contato do autor da menção ou do caso.

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

Publicação

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

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

No entanto, você pode usar a API do Social Connect para criar rascunhos ou enfileirar mensagens para aprovação. Elas serão publicadas quando aprovadas ou publicadas por meio da interface do Social Connect. O ponto de extremidade para mensagens de rascunho é /{account_id}/publisher/add.

Gerenciamento de usuários

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

Não, não é possível alterar o status dos usuários por meio da API. Embora não seja possível alterar o status, você pode alterar o nome, a empresa, o e-mail, o avatar e o horário de funcionamento por meio do ponto de extremidade /{account_id}/settings/user/{id}.

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

É possível alterar 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 a função de um usuário para Administrador. Todas as outras funções de usuário estão disponíveis para alteração por meio do ponto de extremidade /{account_id}/settings/user/{id}.

Posso criar novos usuários por meio da API?

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

Trabalho com perfis sociais

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

Você pode obter informações sobre um determinado perfil social por meio do ponto de extremidade “contato”. 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 esse usuário.

Trabalhando com o Insights

Posso obter estatísticas do Clarabridge Engage?

Você pode extrair dados do Insights usando dois endpoints API diferentes;

1. O ponto de extremidade “/{account_id}/dashboards/export/{dashboard_id}” retorna os dados de todos os widgets em um determinado dashboard. Depois que você ou seus usuários configurarem painéis personalizados, você poderá usar esse endpoint para obter os dados por trás deles.
2. O ponto de extremidade “/{account_id}/insights/facets” atua como o equivalente da API do característica Chart Builder no Social Connect.

Problemas

Onde posso encontrar o ID da minha conta?

Após a autenticação, você pode obter uma lista de todas as contas (e seus IDs) às quais um usuário tem acesso por meio do ponto de extremidade “/me/accounts”.

Onde posso encontrar meu ID de tópico?

Depois de autenticado, 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 extremidade “/me/accounts”.

Onde posso encontrar meu ID de usuário?

Após a autenticação, você pode obter detalhes sobre o usuário autenticado (incluindo seu ID) por meio do ponto de extremidade “/me”.