Guia de início rápido

​

Introdução aos endpoints de busca de Spaces

Este guia de Introdução rápida ajudará você a fazer sua primeira solicitação a um dos endpoints de busca de Spaces com um conjunto de fields especificados usando o Postman.

Se você quiser ver exemplos de código em diferentes linguagens de programação, visite nosso repositório X API v2 sample code GitHub.

​

Pré-requisitos

Para concluir este guia, você precisará ter um conjunto de chaves e tokens para autenticar sua solicitação. Você pode gerar essas chaves e tokens seguindo estas etapas:

• Inscreva-se para uma conta de desenvolvedor e aguarde a aprovação.
• Crie um Projeto e um App de desenvolvedor associado no portal do desenvolvedor.
• Acesse a página “Keys and tokens” do seu App para gerar as credenciais necessárias. Certifique-se de salvar todas as credenciais em um local seguro.

​

Etapas para criar uma solicitação de busca de Spaces

Neste exemplo, faremos uma solicitação ao endpoint de busca de Spaces de usuário por creator ID, mas você pode aplicar o que aprendeu nesta Introdução rápida a outras solicitações de busca também.

Etapa um: Comece com uma ferramenta ou biblioteca

Há diversas ferramentas, exemplos de código e bibliotecas que você pode usar para fazer uma solicitação a este endpoint, mas vamos usar o Postman aqui para simplificar o processo.

Para carregar a coleção do Postman da X API v2 no seu ambiente, clique no botão a seguir:

Add X API v2 to Postman

Depois que você carregar a coleção da X API v2 no Postman, navegue até a pasta Spaces e encontre a solicitação “Lookup Spaces created by one or more users”.  

Etapa dois: Autentique sua solicitação

Para fazer corretamente uma solicitação à X API, você precisa verificar que tem permissão. Para isso, este endpoint exige que você autentique sua solicitação com OAuth 2.0 App-Only ou OAuth 2.0 Authorization Code com PKCE.

Para simplificar, utilizaremos OAuth 2.0 App-Only nesta solicitação, mas você precisará usar um dos outros métodos de autenticação se quiser solicitar metrics privadas ou Spaces de um usuário privado. 

Para utilizar OAuth 2.0 App-Only, você deve adicionar suas chaves e tokens, especificamente o App Access Token (também conhecido como App-only Bearer Token) ao Postman. Você pode fazer isso selecionando o ambiente chamado “X API v2” no canto superior direito do Postman e adicionando suas chaves e tokens nos campos “initial value” e “current value” (clicando no ícone de olho ao lado do menu de seleção de ambiente).

Essas variáveis serão preenchidas automaticamente na guia de autorização da solicitação se você tiver feito isso corretamente.  

Etapa três: Identifique e especifique de qual usuário você deseja recuperar Posts

Você deve especificar um usuário para o qual deseja recuperar Spaces ao vivo ou futuros na solicitação. Neste exemplo, passaremos um único user ID.

User IDs são simplesmente o valor numérico que representa um identificador de conta que você pode encontrar na URL do perfil de uma conta. Por exemplo, o nome de usuário da seguinte conta é XDevelopers.

https://x.com/XDevelopers

Para converter esse nome de usuário em user ID, você deverá usar o endpoint de user lookup com o nome de usuário e encontrar o user ID numérico no payload. No caso de @XDevelopers, o user ID é 2244994945.

No Postman, navegue até a guia “Params” e insira esse user ID na coluna “Value” do parâmetro id.

Key	Value
id	2244994945

Etapa quatro: Identifique e especifique quais fields você deseja recuperar

Se você clicar no botão “Send” após a etapa três, receberá um id, que é o único field do Space object retornado por padrão na sua resposta.

Se você quiser receber fields adicionais, deverá especificá-los na sua solicitação com os parâmetros space.fields ou expansions.

Para este exercício, solicitaremos três conjuntos adicionais de fields de objetos diferentes:

• O field adicional title no objeto principal de Spaces.
• O objeto de usuário completo do creator ID especificado
• O field adicional user.created_at no objeto de usuário associado.

No Postman, navegue até a guia “Params” e adicione o seguinte par key:value à tabela “Query Params”:

Key	Value	Returned fields
space.fields	title	creator_id
expansions	creator_id	includes.users.id, includes.users.name, includes.users.username
user.fields	created_at	includes.users.created_at

Agora você deve ver a seguinte URL ao lado do botão “Send”:

https://api.x.com/2/spaces/by/creator_ids?user_ids=2244994945&space.fields=creator_id&expansions=creator_id&user.fields=created_at

Etapa cinco: faça a sua solicitação e revise a resposta

Quando tudo estiver configurado, clique no botão “Send” e você receberá a seguinte resposta:

{
   "data": [
    {
        "creator_id": "2244994945",
        "id": "1zqKVXPQhvZJB",
        "title": "Olá, mundo 👋",
        "state": "Running"
   },
   "includes": {
       "users": [
           {
               "created_at": "2013-12-14T04:35:55.000Z",
               "name": "Twitter Dev",
               "id": "2244994945",
               "username": "TwitterDev"
           }
       ]
   }
]
}