Ferramentas úteis
Antes de mergulharmos em alguns conceitos-chave que irão ajudar você a integrar este endpoint, recomendamos que você se familiarize com:Postman
Postman é uma ótima ferramenta que você pode usar para testar um endpoint. Cada requisição do Postman inclui todos os parâmetros de caminho e de corpo para ajudá-lo a entender rapidamente o que está disponível. Para saber mais sobre nossas coleções do Postman, visite nossa página “Usando o Postman”.Exemplos de código
Está interessado em começar a usar este endpoint com código na sua linguagem de programação preferida? Temos vários exemplos de código diferentes que você pode usar como ponto de partida na nossa página do Github.Bibliotecas de terceiros
Aproveite uma das bibliotecas de terceiros da nossa comunidade para ajudar você a começar. Você pode encontrar uma biblioteca que funcione com os endpoints v2 procurando pela tag de versão correta.Conceitos-chave
Autenticação
Todos os endpoints da X API v2 exigem que você autentique suas requisições com um conjunto de credenciais, também conhecidas como chaves e tokens. Você pode usar OAuth 1.0a User Context, OAuth 2.0 Authorization Code with PKCE ou App only para autenticar suas requisições nos endpoints de consulta de Lists. No entanto, você deve autenticar com OAuth 1.0a User Context ou OAuth 2.0 para os endpoints de gerenciamento de Lists. OAuth 1.0a User Context, o que significa que você deve usar um conjunto de API Keys e user Access Tokens para fazer uma requisição bem-sucedida. Os access tokens devem estar associados ao usuário em nome de quem você está fazendo a requisição. Se quiser gerar um conjunto de Access Tokens para outro usuário, ele deve autorizar seu App usando o fluxo 3-legged OAuth. 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 que use uma biblioteca, uma ferramenta como o Postman, ou use OAuth 2.0 ou App only para autenticar suas requisições. OAuth 2.0 Authorization Code with 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 específicos de granularidade fina que concedem permissões específicas em nome de um usuário. Para habilitar o OAuth 2.0 no seu App, você deve ativá-lo nas configurações de autenticação do App, encontradas na seção de configurações do App no Developer Console. App only exige apenas que você passe um Access Token App only com sua requisição. Você pode gerar um Access Token App only diretamente em um App de desenvolvedor ou gerá-lo usando o endpoint POST oauth2/token.Developer Console, Projects e developer Apps
Para obter um conjunto de credenciais de autenticação que funcione com os endpoints da X API v2, você precisa criar uma conta de desenvolvedor, configurar um Project dentro dessa conta e criar um App de desenvolvedor dentro desse Project. Você poderá então encontrar suas chaves e tokens dentro do seu App de desenvolvedor.Rate limits
Todos os dias, milhares de desenvolvedores fazem requisições à X API. Para ajudar a gerenciar o grande volume dessas requisições, rate limits são aplicados a cada endpoint, limitando o número de requisições que você pode fazer em nome do seu app ou em nome de um usuário autenticado. Endpoints de consulta (GET) têm rate limit tanto no nível do App quanto do usuário; já os endpoints de gerenciamento (POST/DELETE) têm limite no nível do usuário. O rate limit do app significa que você, o desenvolvedor, só pode fazer um certo número de requisições a este endpoint em um determinado período a partir de qualquer App (assumido pelo uso da API Key e API Secret Key, ou pelo Access Token App only). O rate limit do usuário significa que o usuário autenticado em nome de quem você está fazendo a requisição só pode realizar uma consulta de List um certo número de vezes em qualquer App de desenvolvedor. A tabela abaixo mostra os rate limits para cada endpoint.Fields e expansions
O endpoint GET da X API v2 permite que os usuários selecionem exatamente quais dados desejam que sejam retornados da API usando um conjunto de ferramentas chamadofields e expansions. O parâmetro expansions permite expandir objetos referenciados no payload. Por exemplo, ao consultar membros da List, você pode obter as seguintes expansions:
pinned_tweet_id
fields permite selecionar exatamente quais fields dentro dos diferentes objetos de dados você deseja receber. A consulta de membros da List entrega principalmente objetos de usuário. Por padrão, o objeto de usuário retorna os fields id, name e username. Para receber fields adicionais como user.created_at ou user.description, você terá que solicitá-los especificamente usando um parâmetro user.fields.
Adicionamos um guia sobre como usar fields e expansions.
A tabela abaixo mostra os fields e expansions disponíveis para cada endpoint de consulta: