Documentação Listening - API STILINGUE

Índice:

1. Introdução
2. Documentação do Listening
3. Como é apresentada a documentação e como são apresentados os dados ao programador?

Introdução

A documentação da API é um conteúdo técnico com informações sobre como utilizar e realizar uma integração efetiva com outra API, o que permite mais autonomia na adoção da funcionalidade.

Serviços Personalizados: precisa de ajuda na importação de dados estruturados? Podemos te ajudar! Nosso time de especialistas está pronto para te atender. Entre em contato com o seu Gerente de contas STILINGUE para ter acesso a esse e vários outros serviços.

Para mais informações sobre a API STILINGUE (o que é, como funciona e como adquirir), confira o nosso guia.

Nossa documentação é constantemente atualizada, e atualmente abrange os seguintes pontos:

• Parâmetros obrigatórios e opcionais de entrada;
• Limitações;
• Requerimento de autenticação;
• Métodos aceitos;
• Valor recebido;

A API STILINGUE é disponibilizada para os produtos Listening, Métricas Proprietárias e STILINGUE Smart Care. Confira a seguir os dados extraídos, as limitações e suas possíveis soluções por produto:

Documentação do Listening

É possível extrair dados de quase todas as áreas do menu do Listening, como por exemplo: Mural de publicações, Ranking AAA de Influência, Onde estão falando, Temas e tópicos e Visão Geral.

As limitações de dados da documentação do Listening são as seguintes:

*Devido a medidas de compliance com as redes sociais, alguns dados de publicações precisam ser desidratados e removidos.

Acesse a documentação completa do Listening pelo link: 

https://api.stilingue.com.br/docs/listening#/

Dentro de cada documento de auxílio ao programador explicamos a raiz, o endpoint (URL onde o serviço pode ser acessado) para o começo da “montagem do lego”, um dicionário que ajuda no significado de cada código, as limitações e protocolos da nossa API e as requisições necessárias.

Como é apresentada a documentação e como são apresentados os dados ao programador?

Aqui temos a raiz, o endpoint (URL onde o serviço pode ser acessado) e demais informações, conforme explicado acima.

• Quais são as restrições da API STILINGUE? Nas requisições enviadas, só é possível realizar um pedido por vez; As requisições podem durar até 60 segundos para serem enviadas, por exemplo, quando o intervalo de data é muito longo, ou quando são pedidas muitas publicações. Caso esse tempo exceda, deve-se tentar novamente. Quando a reconexão for necessária, aparecerá a seguinte notificação:

Após adquirir o token de acesso, o próximo passo é abrir a documentação. Com as informações passadas, basta iniciar o projeto:

Dentro da barra de navegação, colocamos primeiro a raiz, em seguida as informações que a documentação entrega (no caso do exemplo acima, as informações de publicações), adicionando o indicado pela seta. Na sequência, inserimos o token de acesso.
Ex: 

Verde: Endpoint (raiz)

Rosa: Requisição de publicações

Amarelo: Token 

Azul: Filtro das 50 publicações dos últimos 7 dias

Os dados da API serão exibidos da seguinte forma: 

Quando os campos estiverem com o valor null, é possível ser um dado desidratado ou é um dado que a rede social não entrega.
Por exemplo: reaction_thankful no Youtube virá como null, pois não é um dado que o Youtube possui, como podemos ver na imagem abaixo: 

Para mais informações, acesse a discussão sobre o assunto em nossa comunidade ou os vídeos no nosso canal. 😃