Guia de integração

Esta página contém informações sobre várias ferramentas e conceitos essenciais que você deve conhecer ao integrar o endpoint de consulta de Posts de uma List ao seu sistema. Dividimos a página em algumas seções:

• Ferramentas úteis
• Conceitos-chave
• Autenticação
• Portal do desenvolvedor, Projetos e Apps
• Limites de requisições
• fields e expansions
• Paginação

​

Ferramentas úteis

Antes de abordarmos alguns conceitos-chave que ajudarão você a integrar este endpoint, recomendamos que você se familiarize com:

​

Postman

O Postman é uma ótima ferramenta que você pode usar para testar um endpoint. Cada requisição no Postman inclui todos os parâmetros de caminho e de corpo para ajudar você a entender rapidamente o que está disponível. Para saber mais sobre nossas coleções do Postman, visite a página “Usando o Postman”. 

​

Exemplos de código

Quer configurar este endpoint com código na sua linguagem de programação preferida? Temos vários exemplos de código disponíveis que você pode usar como ponto de partida na nossa página no GitHub.

​

Bibliotecas de terceiros

Aproveite uma das bibliotecas de terceiros da nossa comunidade para começar. Você pode encontrar uma biblioteca compatível com os endpoints v2 procurando pela tag de versão adequada.

​

Conceitos-chave

​

Autenticação

Todos os endpoints da X API v2 exigem que você autentique suas solicitações com um conjunto de credenciais, também conhecido como chaves e tokens. Você pode usar OAuth 1.0a User Context, App only ou OAuth 2.0 Authorization Code com PKCE para autenticar suas solicitações para este endpoint.

OAuth 1.0a User Context, o que significa que você deve usar um conjunto de API Keys e Access Tokens de usuário para realizar uma solicitação com sucesso. Os access tokens devem estar associados ao usuário em nome de quem você está fazendo a solicitação. Se você quiser gerar um conjunto de Access Tokens para outro usuário, ele deverá autorizar sua App usando o fluxo OAuth de 3 etapas.

Observe que o OAuth 1.0a pode ser difícil de usar. Se você não estiver familiarizado com esse método de autenticação, recomendamos usar uma biblioteca, uma ferramenta como o Postman ou usar OAuth 2.0 ou App only para autenticar suas solicitações.

OAuth 2.0 Authorization Code com PKCE permite maior controle sobre o escopo de uma aplicação e fluxos de autorização em vários dispositivos. O OAuth 2.0 permite escolher escopos granulares específicos que concedem permissões específicas em nome de um usuário.

Para habilitar o OAuth 2.0 na sua App, você deve ativá-lo nas configurações de autenticação da sua App, localizadas na seção de configurações da App no portal do desenvolvedor.

App only requer apenas que você envie um App only Access Token com sua solicitação. Você pode gerar um App only Access Token diretamente em uma App de desenvolvedor ou gerar um usando o endpoint POST oauth2/token.

​

Portal do desenvolvedor, Projetos e Apps de desenvolvedor

Para obter um conjunto de credenciais de autenticação que funcione com os endpoints da X API v2, você deve inscrever-se em uma conta de desenvolvedor, configurar um Projeto nessa conta e criar um App de desenvolvedor dentro desse Projeto. Em seguida, você poderá encontrar suas chaves e tokens no seu App de desenvolvedor.  

​

Limites de requisições

Todos os dias, muitos milhares de desenvolvedores fazem requisições à X API. Para ajudar a gerenciar o grande volume dessas requisições, limites de taxa são aplicados a cada endpoint, restringindo o número de requisições que você pode fazer em nome da sua App ou de um usuário autenticado. 

Este endpoint tem limite de requisições tanto no nível da App quanto no nível do usuário. O limite da App significa que você, desenvolvedor, só pode fazer um certo número de requisições para este endpoint em um determinado período de tempo a partir de qualquer App (considerando o uso de API Key e Chave secreta da API, ou do Bearer Token). O limite do usuário significa que o usuário autenticado em cujo nome você está fazendo a requisição só pode realizar uma consulta de Posts de List um certo número de vezes em qualquer App de desenvolvedor.

A tabela abaixo mostra os limites de requisições para cada endpoint.

Endpoint	método HTTP	limite de taxa
/2/lists/:id/tweets	GET	900 requisições por 15 minutos

Fields and expansions

O endpoint GET da X API v2 permite que os usuários selecionem exatamente quais dados desejam retornar da API usando um conjunto de ferramentas chamadas fields e expansions. O parâmetro expansions permite expandir objetos referenciados no payload. Por exemplo, consultar Posts de List permite obter as seguintes expansions:

• author_id

O parâmetro fields permite selecionar exatamente quais fields dentro dos diferentes objetos de dados você deseja receber. Este endpoint retorna principalmente Objeto Post. Por padrão, o Objeto Post retorna os campos id e text. Para receber campos adicionais como tweet.created_at ou tweet.lang, você terá que solicitá-los especificamente usando um parâmetro fields. 

Adicionamos um guia sobre como usar fields e expansions juntos em nosso dicionário de dados da X API v2.

A tabela abaixo mostra os fields e expansions disponíveis para o endpoint de consulta:

Endpoint	Fields	Expansions
/2/lists/:id/tweets	tweet.fields user.fields	author_id

Paginação

Consultar Posts de List pode retornar muitos dados. Para garantir resultados consistentes e de alto desempenho a qualquer momento, usamos paginação. Paginação é um recurso em endpoints da X API v2 que retornam mais resultados do que cabem em uma única resposta. Quando isso acontece, os dados são retornados em uma série de “páginas”. Saiba mais sobre como paginar os resultados.