Guía de inicio rápido

​

Introducción al endpoint de búsqueda de Listas

Esta guía de inicio rápido te ayudará a realizar tu primera solicitud al endpoint de búsqueda de Listas usando Postman.

Visita nuestro repositorio de GitHub de X API v2 sample code si quieres ver ejemplos de código en diferentes lenguajes.

Nota: Para este ejemplo, haremos una solicitud al endpoint List lookup by ID, pero puedes aplicar lo aprendido en este inicio rápido a otras solicitudes de búsqueda.

​

Requisitos previos

Para completar esta guía, necesitarás un conjunto de claves y tokens para autenticar tu solicitud. Puedes generar estas claves y tokens siguiendo estos pasos:

• Regístrate para obtener una cuenta de desarrollador y recibe la aprobación.
• Crea un Project y una App de desarrollador asociada en el Portal de desarrolladores.
• Ve a la página “Keys and tokens” de tu App para generar las credenciales necesarias. Asegúrate de guardar todas las credenciales en un lugar seguro.

​

Pasos para crear una solicitud de búsqueda de Listas

Paso uno: Comienza con una herramienta o biblioteca

Existen varias herramientas, ejemplos de código y bibliotecas que puedes usar para hacer una solicitud a este endpoint, pero aquí usaremos la herramienta Postman para simplificar el proceso.

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

Agregar X API v2 a Postman

Una vez que tengas la colección de X API v2 cargada en Postman, navega a la carpeta “List”, selecciona la carpeta “List lookup” y luego elige “List by ID”.  

Paso dos: Autentica tu solicitud

Para realizar correctamente una solicitud a la X API, debes verificar que tienes permiso. Para hacerlo con este endpoint, debes autenticar tu solicitud con alguno de los métodos de autenticación App only, Código de autorización de OAuth 2.0 con PKCE o Contexto de usuario de OAuth 1.0a.

Por simplicidad, utilizaremos App only con esta solicitud, pero si deseas solicitar métricas privadas o Listas, deberás usar uno de los otros métodos de autenticación. 

Para utilizar App only, debes agregar tus claves y tokens (específicamente el App only Access Token) a Postman seleccionando el entorno llamado “X API v2” (en la esquina superior derecha de Postman) y añadiendo tus claves y tokens a los campos “initial value” y “current value” (haciendo clic en el icono de ojo junto al menú desplegable del entorno).

Si has hecho esto correctamente, estas variables se incorporarán automáticamente en la pestaña de autorización de la solicitud.  

Paso tres: Identifica y especifica qué Lista deseas recuperar

Debes especificar una Lista que deseas recibir en la solicitud. Puedes encontrar el ID de la Lista navegando a x.com, haciendo clic en una Lista y luego comprobando la URL. Por ejemplo, el ID de la Lista de la siguiente URL es 84839422.

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

El ID de destino puede ser cualquier ID de Lista válido. En Postman, navega a la pestaña “Params” e ingresa tu ID en la columna “Value” de la variable de ruta id. Asegúrate de no incluir espacios antes o después de ningún ID.

Key	Value
id	84839422 (El ID de la Lista)

Paso cuatro: Identifica y especifica qué fields deseas recuperar

Si haces clic en el botón “Send” después del paso tres, recibirás en tu respuesta los fields predeterminados del List object: id, name.

Si deseas recibir fields adicionales, tendrás que especificarlos en tu solicitud con list.fields y/o parámetros de expansion.

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

• El field adicional created_at en el objeto principal de Listas.

• El user object completo usando el parámetro de expansion

• El field adicional user.created_at en el objeto de usuario asociado.

En Postman, navega a la pestaña “Params” y agrega el siguiente par clave:valor a la tabla “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

Ahora deberías ver una URL similar junto al botón “Send”:

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

Paso cinco: Realiza tu solicitud y revisa tu respuesta

Una vez que tengas todo configurado, presiona el botón “Send” y recibirás una respuesta similar al siguiente ejemplo de respuesta:

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