Introdução rápida

​

Introdução ao endpoint de List lookup

Este guia de introdução rápida ajudará você a fazer sua primeira solicitação ao endpoint de List lookup usando o Postman.

Visite nosso repositório no GitHub X API v2 Sample code se quiser ver exemplos de código em diferentes linguagens.

Observação: Neste exemplo, faremos uma solicitação ao endpoint List lookup by ID, mas você pode aplicar o que aprender neste guia de introdução rápida a outras solicitações de lookup também.

​

Pré-requisitos

Para concluir este guia, você precisará de 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 consulta de List

Etapa 1: Comece com uma ferramenta ou biblioteca

Há várias ferramentas, exemplos de código e bibliotecas que você pode usar para fazer uma solicitação a este endpoint, mas usaremos a ferramenta 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 “List”, selecione a pasta “List lookup” e, em seguida, escolha “List by ID”.  

Etapa 2: Autentique sua solicitação

Para fazer corretamente uma solicitação à X API, você precisa verificar que tem permissão. Para fazer isso com este endpoint, você deve autenticar sua solicitação com um dos métodos de autenticação App only, OAuth 2.0 Authorization Code with PKCE ou OAuth 1.0a User Context.

Para simplificar, usaremos App only nesta solicitação, mas, se você quiser solicitar metrics privadas ou Lists, precisará usar um dos outros métodos de autenticação. 

Para utilizar App only, você deve adicionar suas chaves e tokens (especificamente o App only Access Token) ao Postman, 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 suspenso de ambientes).

Se você fez isso corretamente, essas variáveis serão automaticamente inseridas na guia de autorização da solicitação.  

Etapa 3: Identifique e especifique qual List você deseja recuperar

Você deve especificar uma List que deseja receber na solicitação. Você pode encontrar o List ID navegando em x.com, clicando em uma List e, então, olhando a URL. Por exemplo, o List ID da seguinte URL é 84839422.

https://x.com/i/lists/84839422

O ID de destino pode ser qualquer List ID válido. No Postman, navegue até a guia “Params” e insira seu ID na coluna “Value” da variável de caminho id. Certifique-se de não incluir espaços antes ou depois de qualquer ID.

Key	Value
id	84839422 (The List ID)

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

Se você clicar no botão “Send” após a etapa três, receberá os fields padrão do List object na sua resposta: id, name.

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

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

• O field adicional created_at no objeto principal de Lists.

• O user object completo usando o parâmetro expansions

• 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
list.fields	created_at	created_at
expansions	owner_id	includes.users.id, includes.users.name, includes.users.username
user.fields	created_at	includes.users.created_at

Agora você deverá ver uma URL semelhante ao lado do botão “Send”:

https://api.x.com/2/lists/84839422?list.fields=owner_id&expansions=owner_id&user.fields=created_at

Etapa 5: Faça sua solicitação e revise sua resposta

Depois que tudo estiver configurado, clique no botão “Send” e você receberá uma resposta semelhante ao exemplo a seguir:

{
  "data": {
    "id": "84839422",
    "name": "Contas Oficiais do Twitter",
    "owner_id": "783214"
  },
  "includes": {
    "users": [
      {
        "name": "Twitter",
        "created_at": "2007-02-20T14:35:54.000Z",
        "username": "Twitter",
        "id": "783214"
      }
    ]
  }
}