Saltar al contenido principal

​
Introducción al endpoint de consulta de bloqueos

Esta guía rápida le ayudará a realizar su primera solicitud al endpoint de consulta de bloqueos con Postman. Si desea ver código de muestra en distintos lenguajes, visite nuestro repositorio de GitHub X API v2 Sample code.

​
Requisitos previos

Para completar esta guía, necesitará un conjunto de keys and tokens para autenticar su solicitud. Puede generar estas keys and tokens siguiendo estos pasos:

​
Pasos para crear una solicitud de consulta de bloqueos

​
Paso uno: Comience con una herramienta o biblioteca

Existen varias herramientas, ejemplos de código y bibliotecas que puede usar para realizar una solicitud a este endpoint, pero aquí utilizaremos la herramienta Postman para simplificar el proceso. Para cargar en su entorno la colección de Postman de X API v2, haga clic en el siguiente botón:
Una vez que tenga la colección de X API v2 cargada en Postman, vaya a la carpeta “Blocks” y seleccione “Blocks Lookup”.  

​
Paso dos: Autentique su solicitud

Para realizar correctamente una solicitud a la X API, debe verificar que tiene permiso. Para hacerlo con este endpoint, debe autenticar su solicitud usando Contexto de usuario de OAuth 1.0a o Código de autorización de OAuth 2.0 con PKCE. En este ejemplo, usaremos el Contexto de usuario de OAuth 1.0a. Debe añadir sus keys and tokens —específicamente su API Key, Clave secreta de la API, OAuth 1.0a user Access Token y OAuth 1.0a user Access Token Secret— a Postman. Puede hacerlo seleccionando el entorno llamado “X API v2” en la esquina superior derecha de Postman y añadiendo sus keys and tokens a los campos “initial value” y “current value” (haciendo clic en el icono de ojo junto al menú desplegable del entorno). Estas variables se incorporarán automáticamente en la pestaña de autorización de la solicitud si lo ha hecho correctamente.  

​
Paso tres: Especifica un usuario

Con este endpoint, debes especificar tu id de usuario o el id de un usuario autenticado para ver a quién has bloqueado. En Postman, ve a la pestaña “Params” e introduce este nombre de usuario en la columna “Value” de la variable de ruta id (al final de la sección), asegurándote de no incluir espacios antes ni después de los nombres de usuario.  
KeyValue
id(tu id de usuario)
max_results5

​
Paso cuatro: Identifique y especifique qué campos desea recuperar

Si hace clic en el botón “Send” después del paso tres, recibirá en su respuesta los campos predeterminados del objeto de usuario: id, name y username. Si desea recibir campos adicionales más allá de id, name y username, deberá especificarlos en su solicitud con los parámetros fields y/o expansions. Para este ejercicio, solicitaremos tres conjuntos adicionales de campos de distintos objetos:
  1. El campo adicional user.created_at en los objetos de usuario principales.
  2. Los campos predeterminados del objeto de Posts fijados asociados para los usuarios devueltos: id y text.
  3. El campo adicional tweet.created_at en los objetos de Post asociados.
En Postman, vaya a la pestaña “Params” y agregue el siguiente par key:value a la tabla “Query Params”:
KeyValueReturned fields
user.fieldscreated_atuser.created_at
expansionspinned_tweet_idtweet.id, tweet.text
tweet.fieldscreated_atincludes.tweets.created_at
Ahora debería ver una URL similar con su propio user ID en lugar de la URL de TwitterDev junto al botón “Send”: 
      https://api.x.com/2/users/2244994945/blocking?user.fields=created_at&expansions=pinned_tweet_id&tweet.fields=created_at

​
Paso cinco: Realiza tu solicitud y revisa tu respuesta

Una vez que tengas todo configurado, haz clic en el botón “Send” y recibirás una respuesta similar al siguiente ejemplo: 
    {
  "data": [
    {
      "created_at": "2008-12-04T18:51:57.000Z",
      "id": "17874544",
      "username": "TwitterSupport",
      "name": "Soporte de 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": "ahora, cualquier persona con 600 o más seguidores puede ser anfitrión de un Space.\n\nbasándonos en lo que hemos aprendido, es probable que estas cuentas tengan una buena experiencia como anfitriones debido a su audiencia existente. antes de brindar la capacidad de crear un Space a todos, nos estamos enfocando en algunas cosas. 🧵"
      },
      {
        "created_at": "2020-08-12T17:11:04.000Z",
        "id": "1293595870563381249",
        "text": "X API v2: Acceso anticipado lanzado\n\nHoy anunciamos el acceso anticipado a los primeros endpoints de la nueva Twitter API!\n\n#TwitterAPI #EarlyAccess #VersionBump https://t.co/g7v3aeIbtQ"
      }
    ]
  }

​
Paso seis: pagina por tus resultados

Es posible que notes un objeto meta al final de la respuesta. Si recibiste un next_token, esto indica que hay otra página de resultados que se puede recuperar. Para obtener la siguiente página, toma el valor del campo next_token y agrégalo a la solicitud como valor de un parámetro adicional llamado pagination_token.  
ClaveValor
pagination_token1D3PU6DRII9HEZZZ
Si envías la solicitud después de agregar este parámetro adicional, los siguientes cinco resultados se entregarán en la carga útil siguiente, dado que especificamos max_results en 5 en el paso tres. Puedes repetir este proceso hasta que se hayan devuelto todos los resultados, pero también puedes usar el parámetro max_results para solicitar hasta 1000 usuarios por solicitud, de modo que no tengas que paginar tanto los resultados.
⌘I