Pular para o conteúdo principal
Este guia apresenta etapas que você pode seguir para fazer sua primeira solicitação. É um excelente recurso para ajudar você após criar uma conta na X. Se você tiver interesse em usar exemplos de código, guias mais técnicos ou uma ferramenta gráfica como o Postman, considere os seguintes guias para fazer sua primeira solicitação: Este guia pressupõe que você já coletou sua API Key e secret, user Access Token and Secret, App Access Token e os armazenou em um local seguro. Você pode aprender como fazer isso seguindo as etapas do guia obtendo acesso à X API.

​
Etapa 1. Identifique qual endpoint você deseja usar

A X API permite executar uma variedade de ações por meio de código, semelhantes às que você pode realizar no site ou no aplicativo móvel da X. Temos uma lista completa dos endpoints disponíveis na API em nosso Índice de referência da API, mas recomendamos ficar com um dos seguintes para simplificar:

​
Etapa 2. Escolha uma ferramenta para fazer sua solicitação

Embora algumas solicitações sejam simples, outras podem ser complexas de criar. É por isso que a comunidade de desenvolvedores criou ferramentas para abstrair parte dessa complexidade. A seguir, algumas ferramentas recomendadas e detalhes sobre como usá-las:

​
Postman

Postman é uma ferramenta visual que você pode usar para fazer requisições a endpoints REST. Criamos materiais abrangentes sobre o Postman para ajudar você a começar e explorar os diferentes endpoints disponíveis por meio da X API. Recomendamos que você leia nosso tutorial “Introdução ao Postman” para aprender como adicionar suas chaves e tokens e fazer sua primeira requisição. Também produzimos um guia de Introdução rápida para cada um de nossos endpoints da X API v2, a maioria dos quais utiliza o Postman. Você pode encontrar esses guias na respectiva seção de cada endpoint, mas aqui estão alguns links:
  • Introdução rápida: Publicar um Tweet
  • Introdução rápida: Pesquisar Posts
  • Introdução rápida: Consultar um usuário
Observe que não é possível fazer requisições a endpoints de stream usando o Postman. Visite o guia de Introdução rápida do stream filtrado ou do stream com amostragem de 1% para aprender como trabalhar com esses endpoints. Se você preferir uma ferramenta gráfica mais simples, considere também usar o Insomnia.

​
Exemplo de código

Se você quiser usar um código simples para fazer sua solicitação, reunimos exemplos em várias linguagens para cada um dos nossos endpoints da X API v2. Você pode encontrar os exemplos de código no nosso repositório no GitHub, X-API-v2-sample-code, que também contém um arquivo README com instruções para configurar suas credenciais e fazer as solicitações corretamente. Por exemplo, aqui está um exemplo em cURL para o endpoint de busca de usuário. Tudo o que você precisa fazer para usar essa solicitação é substituir ACCESS_TOKEN e USERNAME pelo seu App Access Token e pelo seu @ de X. Em seguida, copie e cole este código na sua ferramenta de linha de comando e pressione Enter (ou Return). 
curl "https://api.x.com/2/users/by/username/$USERNAME" -H "Authorization: Bearer $ACCESS_TOKEN"

​
Bibliotecas

A incrível comunidade de desenvolvedores da X também criou bibliotecas em diversas linguagens de programação que podem ser usadas para fazer solicitações à X API. Criamos uma página de “Ferramentas e bibliotecas” que lista todas as bibliotecas da comunidade das quais temos conhecimento. Cada biblioteca deve ter um arquivo README que pode ser usado para aprender a configurar o repositório na sua máquina e fazer sua primeira solicitação.
Observação: Se você encontrar algum problema, consulte nossa documentação para desenvolvedores do endpoint ao qual você está fazendo a solicitação, nossa seção de suporte ou entre em contato com a comunidade em nossos fóruns para obter ajuda. Vamos ajudá-lo a realizar uma solicitação bem-sucedida!

​
Etapa 3. Analise a resposta

Depois que você fizer uma solicitação bem-sucedida, receberá um payload com metadata relacionada à solicitação. Se você usou um endpoint que utiliza o método HTTP GET, receberá metadata relacionada ao recurso (Post, user, List, Space, etc.) para o qual fez a solicitação, em formato JSON. Analise os diferentes fields retornados e veja se consegue mapear as informações solicitadas ao conteúdo no X. Se você usou um endpoint que utiliza os métodos HTTP POST, PUT ou DELETE, uma ação foi executada no X. Acesse X.com ou o App móvel e veja se consegue localizar essa ação.

​
Etapa 4. Ajuste sua solicitação usando parâmetros

Cada endpoint tem um conjunto diferente de parâmetros que você pode usar para ajustar sua solicitação. Por exemplo, você pode solicitar campos adicionais de metadata ao usar endpoints GET com os parâmetros fields e expansions. Você também pode experimentar diversas ferramentas de filtragem com endpoints como search Posts, Post counts e filtered stream para ajudar a restringir os dados recebidos apenas aos Posts do seu interesse. Você pode encontrar a lista completa de parâmetros de solicitação e fields na API Reference do endpoint com o qual está trabalhando, além de várias outras informações úteis de integração em nossos guias de integração e páginas de fundamentos. Você pode saber mais sobre todos os materiais educacionais que disponibilizamos no nosso guia Important resources.
⌘I