Guía rápida

​

Introducción al endpoint de búsqueda de List

Esta guía rápida le ayudará a realizar su primera solicitud al endpoint de búsqueda de List con Postman.

Visite nuestro repositorio de GitHub X API v2 sample code si desea ver código de muestra en distintos lenguajes.

Nota: Para este ejemplo, haremos una solicitud al endpoint List lookup by ID, pero puede aplicar lo aprendido en esta guía rápida a otras solicitudes de búsqueda.

​

Requisitos previos

Para completar esta guía, necesitará contar con un conjunto de keys and tokens para autenticar 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 requeridas. Asegúrese de guardar todas las credenciales en un lugar seguro.

​

Pasos para crear una solicitud de búsqueda de List

Paso uno: comience con una herramienta o biblioteca

Hay varias herramientas, ejemplos de código y bibliotecas que puede usar para realizar 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 su entorno, haga clic en el siguiente botón:

Add X API v2 to Postman

Una vez que tenga la colección de X API v2 cargada en Postman, navegue a la carpeta “List”, seleccione la carpeta “List lookup” y luego elija “List by ID”.  

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 con los métodos de autenticación App only, OAuth 2.0 Authorization Code with PKCE o OAuth 1.0a User Context.

Para simplificar, utilizaremos App only en esta solicitud, pero si desea solicitar metrics privadas o Lists, deberá usar uno de los otros métodos de autenticación. 

Para utilizar App only, debe agregar sus keys and 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 agregando sus keys and tokens en los campos “initial value” y “current value” (haciendo clic en el ícono de ojo junto al menú desplegable del entorno).

Si lo ha hecho correctamente, estas variables se cargarán automáticamente en la pestaña de autorización de la solicitud.  

Paso tres: identifique y especifique qué List desea recuperar

Debe especificar una List que desee recibir dentro de la solicitud. Puede encontrar el List ID navegando a x.com, haciendo clic en una List y luego mirando la URL. Por ejemplo, el List ID de la siguiente URL es 84839422.

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

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

Key	Value
id	84839422 (List ID)

Paso cuatro: identifique y especifique qué fields desea recuperar

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

Si desea recibir fields adicionales, deberá especificarlos en su solicitud con los parámetros list.fields y/o expansions.

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

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

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

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

En Postman, navegue a la pestaña “Params” y agregue el siguiente par key:value 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ía 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: realice su solicitud y revise su respuesta

Una vez que tenga todo configurado, presione el botón “Send” y recibirá 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"
      }
    ]
  }
}