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
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 para autenticar suas requisições neste endpoint. 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 ou uma ferramenta como o Postman.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. Esses endpoints têm rate limit no nível do usuário, o que significa que o usuário autenticado em nome de quem você está fazendo a requisição só pode chamar o endpoint 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 Lists fixadas, você pode obter as seguintes expansions:
owner_id
fields permite selecionar exatamente quais fields dentro dos diferentes objetos de dados você deseja receber. Este endpoint entrega principalmente objetos de usuário. Por padrão, o objeto List retorna os fields id e name. Para receber fields adicionais como list.created_at ou list.description, você terá que solicitá-los especificamente usando um parâmetro fields.
Adicionamos ao nosso dicionário de dados da X API v2 um guia sobre como usar fields e expansions em conjunto.
A tabela abaixo mostra os fields e expansions disponíveis para o endpoint de consulta: