Pular para o conteúdo principal

​
Introdução ao endpoint de consulta de bloqueios

Este guia de introdução rápida ajudará você a fazer sua primeira solicitação ao endpoint de consulta de bloqueios usando o Postman. Se você quiser ver exemplos de código em diferentes linguagens, visite nosso repositório no GitHub X API v2 sample code.

​
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:

​
Etapas para criar uma solicitação de busca de bloqueios

​
Etapa um: 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 aqui usaremos o Postman para simplificar o processo. Para carregar a coleção do X API v2 do Postman no seu ambiente, clique no botão a seguir:
Depois que a coleção do X API v2 estiver carregada no Postman, navegue até a pasta “Blocks” e selecione “Blocks Lookup”.  

​
Etapa dois: autentique sua solicitação

Para fazer uma solicitação corretamente à X API, você precisa verificar que tem permissão. Para isso, neste endpoint, você deve autenticar sua solicitação usando OAuth 1.0a User Context ou OAuth 2.0 Authorization Code with PKCE. Neste exemplo, usaremos OAuth 1.0a User Context. Você deve adicionar suas chaves e tokens — especificamente sua API Key, Chave secreta da API, OAuth 1.0a user Access Token e OAuth 1.0a user Access Token Secret — 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 aos campos “initial value” e “current value” (clicando no ícone de olho ao lado do menu suspenso do ambiente). Essas variáveis serão preenchidas automaticamente na guia Authorization da solicitação se você tiver feito tudo corretamente.  

​
Etapa três: especifique um usuário

Com este endpoint, você deve informar seu id de usuário ou o id de um usuário autenticado para ver quem você bloqueou. No Postman, vá até a aba “Params” e insira esse nome de usuário na coluna “Value” da variável de caminho id (na parte inferior da seção), certificando-se de não incluir espaços antes ou depois dos nomes de usuário.  
KeyValue
id(seu id de usuário)
max_results5

​
Etapa quatro: identifique e especifique quais fields você deseja recuperar

Se você clicar no botão “Send” após a etapa três, receberá na resposta os fields padrão do objeto de usuário: id, name e username. Se desejar receber fields adicionais além de id, name e username, será necessário especificá-los na sua solicitação com os parâmetros fields e/ou expansions. Para este exercício, solicitaremos três conjuntos adicionais de fields de diferentes objetos:
  1. O field adicional user.created_at nos objetos de usuário primários.
  2. Os fields padrão do objeto dos Posts fixados associados para os usuários retornados: id e text.
  3. O field adicional tweet.created_at nos objetos de Post associados.
No Postman, acesse a guia “Params” e adicione o seguinte par key:value à tabela “Query Params”:
KeyValueReturned fields
user.fieldscreated_atuser.created_at
expansionspinned_tweet_idtweet.id, tweet.text
tweet.fieldscreated_atincludes.tweets.created_at
Agora você deve ver uma URL semelhante com seu próprio user ID em vez da URL do TwitterDev ao lado do botão “Send”: 
      https://api.x.com/2/users/2244994945/blocking?user.fields=created_at&expansions=pinned_tweet_id&tweet.fields=created_at

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

Depois que tudo estiver configurado, clique no botão “Send” e você receberá uma resposta semelhante ao exemplo a seguir: 
    {
  "data": [
    {
      "created_at": "2008-12-04T18:51:57.000Z",
      "id": "17874544",
      "username": "TwitterSupport",
      "name": "Suporte do Twitter"
    },
    {
      "created_at": "2007-02-20T14:35:54.000Z",
      "id": "783214",
      "username": "Twitter",
      "name": "Twitter"
    },
    {
      "pinned_tweet_id": "1389270063807598594",
      "created_at": "2018-11-21T14:24:58.000Z",
      "id": "1065249714214457345",
      "username": "TwitterSpaces",
      "name": "Spaces"
    },
    {
      "pinned_tweet_id": "1293595870563381249",
      "created_at": "2007-05-23T06:01:13.000Z",
      "id": "6253282",
      "username": "XAPI",
      "name": "X API"
    }
  ],
  "includes": {
    "tweets": [
      {
        "created_at": "2021-05-03T17:26:09.000Z",
        "id": "1389270063807598594",
        "text": "agora, todos com 600 ou mais seguidores podem criar um Space.\n\ncom base no que aprendemos, essas contas provavelmente terão uma boa experiência como anfitriãs devido ao seu público existente. antes de disponibilizar a capacidade de criar um Space para todos, estamos focados em algumas coisas. 🧵"
      },
      {
        "created_at": "2020-08-12T17:11:04.000Z",
        "id": "1293595870563381249",
        "text": "X API v2: Acesso Antecipado lançado\n\nHoje anunciamos o Acesso Antecipado aos primeiros endpoints da nova Twitter API!\n\n#TwitterAPI #EarlyAccess #VersionBump https://t.co/g7v3aeIbtQ"
      }
    ]
  }

​
Etapa seis: pagine pelos seus resultados

Você pode notar que há um objeto meta localizado na parte inferior da resposta. Se você recebeu um next_token, isso indica que há outra página de resultados que podemos recuperar. Para obter a próxima página de resultados, você deve capturar o valor do campo next_token e adicioná-lo à solicitação como o valor de um parâmetro adicional pagination_token.  
ChaveValor
pagination_token1D3PU6DRII9HEZZZ
Se você enviar a solicitação após adicionar esse parâmetro adicional, os próximos cinco resultados serão retornados na carga útil subsequente, já que especificamos max_results como 5 na etapa três. Você pode continuar repetindo esse processo até que todos os resultados sejam retornados, mas também pode usar o parâmetro max_results para solicitar até 1000 contas por solicitação, para não precisar paginar pelos resultados com tanta frequência.
⌘I