Consulta de usuarios

​

Introducción a los endpoints de consulta de usuarios

Esta guía de inicio rápido le ayudará a realizar su primera solicitud a los endpoints de consulta de usuarios con un conjunto de fields especificados usando Postman.

Si desea ver código de ejemplo en diferentes 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 la Autenticación de su solicitud. Puede generar estas keys and tokens siguiendo estos pasos:

• Regístrese para obtener una cuenta de desarrollador y reciba la aprobación.
• Cree un Project y una developer App asociada en el Portal de desarrolladores.
• Vaya a la página “Keys and tokens” de su App para generar las credenciales necesarias. Asegúrese de guardar todas las credenciales en una ubicación segura.

​

Pasos para crear una solicitud de consulta de usuarios

​

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í usaremos Postman para simplificar el proceso.

Para cargar la colección de Postman de X API v2 en su entorno, haga clic en el siguiente botón:

Agregar X API v2 a Postman

Una vez que haya cargado la colección de X API v2 en Postman, navegue al endpoint GET /users/by.  

​

Paso dos: autentica tu solicitud

Para realizar correctamente una solicitud a la X API, debes verificar que cuentas con permiso. Para ello, este endpoint requiere que autentiques tu solicitud con App only, Código de autorización de OAuth 2.0 con PKCE o Contexto de usuario de OAuth 1.0a.

Para simplificar, usaremos App only con esta solicitud, pero deberás usar uno de los otros métodos de Autenticación si deseas solicitar metrics privadas o datos de usuarios.

Para utilizar App only, debes agregar tus keys y tokens, específicamente el App Access Token (también conocido como el App only Bearer Token) en Postman. Puedes hacerlo seleccionando el entorno llamado “X API v2” en la esquina superior derecha de Postman y agregando tus keys y tokens en los campos “initial value” y “current value” (haciendo clic en el ícono 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 has hecho correctamente.  

​

Paso tres: Identifique y especifique qué usuario(s) desea recuperar

Debe especificar uno o varios usuarios que desea recibir en la solicitud. Según el endpoint de usuario que utilice, puede pasar un id de usuario o un nombre de usuario. En esta situación, usaremos el endpoint GET /users/by, que le permite pasar varios nombres de usuario en una sola solicitud (en lugar de los endpoints de single-ID, multi-ID y single-username) y enviar un conjunto de nombres de usuario mediante el parámetro de consulta usernames.

Los nombres de usuario son simplemente el handle de la cuenta que puede encontrar en la URL del perfil de una cuenta. Por ejemplo, el nombre de usuario de la siguiente cuenta es XDevelopers.

https://x.com/XDevelopers

En Postman, vaya a la pestaña “Params” e ingrese este nombre de usuario, o una cadena de nombres de usuario separados por comas, en la columna “Value” del parámetro username, asegurándose de no incluir espacios entre los nombres de usuario y las comas.

Key	Value
username	XDevelopers,API,adsapi

​

Paso cuatro: Identifique y especifique qué fields desea recuperar

Si hace clic en el botón “Send” después del paso tres, recibirá en su respuesta los fields predeterminados del user object: id, name y username.

Si desea recibir fields adicionales más allá de id, name y username, deberá especificarlos en su solicitud con los parámetros field y/o expansion.

Para este ejercicio, solicitaremos tres conjuntos adicionales de fields de diferentes objetos:

1. El field adicional user.created_at en los objetos de usuario principales.
2. Los fields predeterminados del objeto de Posts fijados asociados para los usuarios devueltos: id y text.
3. El field adicional tweet.created_at en los objetos de Post asociados.  

En Postman, navegue a la pestaña “Params” y agregue el siguiente par key:value a la tabla “Query Params”:

Key	Value	Returned fields
user.fields	created_at	user.created_at
expansions	author_id	tweet.id, tweet.text
tweet.fields	created_at	includes.users.created_at

Ahora debería ver la siguiente URL junto al botón “Send”:

      https://api.x.com/2/users/by?usernames=twitterdev,twitterapi,adsapi&user.fields=created_at&expansions=pinned_tweet_id&tweet.fields=author_id,created_at

​

Paso cinco: Envía tu solicitud y revisa la respuesta

Una vez que tengas todo configurado, haz clic en el botón “Send” y recibirás la siguiente respuesta:

{
  "data": [
    {
      "created_at": "2013-12-14T04:35:55.000Z",
      "id": "2244994945",
      "name": "X Dev",
      "pinned_tweet_id": "1255542774432063488",
      "username": "TwitterDev"
    },
    {
      "created_at": "2007-05-23T06:01:13.000Z",
      "id": "6253282",
      "name": "X API",
      "username": "TwitterAPI"
    },
    {
      "created_at": "2013-02-27T20:01:12.000Z",
      "id": "1225933934",
      "name": "X Ads API",
      "username": "AdsAPI"
    }
  ],
  "includes": {
    "tweets": [
      {
        "author_id": "2244994945",
        "created_at": "2020-04-29T17:01:38.000Z",
        "id": "1255542774432063488",
        "text": "En estos tiempos sin precedentes, lo que sucede en X puede ayudar al mundo a comprender mejor y responder a la pandemia. \n\nEstamos lanzando un endpoint de transmisión de COVID-19 gratuito para que desarrolladores e investigadores cualificados puedan estudiar la conversación pública en tiempo real. https://t.co/BPqMcQzhId"
      }
    ]
  }
}