Saltar al contenido principal

​
Introducción al grupo de endpoints para gestionar Listas

Esta breve introducción te ayudará a realizar tu primera solicitud a los endpoints para gestionar Listas usando Postman. Si deseas ver código de ejemplo en distintos lenguajes, visita nuestro repositorio de GitHub X API v2 sample code. Nota: En este ejemplo, realizaremos una solicitud al endpoint Create a List, pero también puedes aplicar lo aprendido en este inicio rápido a otras solicitudes de gestión.
Requisitos previosPara completar esta guía, necesitarás un conjunto de keys and tokens para autenticar tu solicitud. Puedes generarlos siguiendo estos pasos:

​
Pasos para crear una solicitud para administrar una List

Paso uno: Comienza con una herramienta o biblioteca Hay varias herramientas, ejemplos de código y bibliotecas que puedes 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 tu entorno, haz clic en el siguiente botón:
Una vez que tengas la colección de X API v2 cargada en Postman, navega a la carpeta “List”, selecciona la carpeta “Manage List” y luego elige “Create a List”. Paso dos: Autentica tu solicitud Para realizar correctamente una solicitud a la X API, debes verificar que tienes permiso para hacerlo. Para ello, con los endpoints de administración de Posts, debes autenticar tu solicitud usando ya sea Contexto de usuario de OAuth 1.0a o Código de autorización de OAuth 2.0 con PKCE. En este ejemplo, vamos a usar el Contexto de usuario de OAuth 1.0a. Debes agregar tus keys y tokens (específicamente tu API Key, API Secret Key, OAuth 1.0a user Access Token y OAuth 1.0a user Access Token Secret) a 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 del ojo junto al menú desplegable del entorno). Si lo hiciste correctamente, estas variables se incorporarán automáticamente en la pestaña de autorización de la solicitud.   Paso tres: Especifica el nombre de la nueva List Al crear una nueva List con este endpoint, el nombre de la List es un parámetro obligatorio del cuerpo. Opcionalmente, puedes proporcionar una descripción y especificar si la List es privada. En Postman, navega a la pestaña “Body” e ingresa el nombre de la List como valor del parámetro name. Además, si deseas agregar una descripción para la List, simplemente agrega una nueva clave llamada description del mismo modo que name, seguida de la descripción de la List como valor. Hacer que una List sea privada sigue el mismo patrón, pero solo se aceptan valores true o false para este parámetro. 
KeyValueParameter type
nameNombre de la list (obligatorio)body
descriptionDescripción de la list (opcional)body
privatetrue o false (opcional)body
Ahora deberías ver una URL similar junto al botón “Send”: https://api.x.com/2/lists Paso cuatro: 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": "1441162269824405510",
    "name": "Nueva lista creada con Postman"
  }
}
Si el objeto de respuesta devuelto contiene un id y el nombre de tu Lista, has creado la Lista correctamente.  Para eliminar una Lista, selecciona la solicitud “Delete a List”, que también se encuentra en la carpeta “Lists” de la colección de X API v2 cargada en Postman. Este endpoint requiere el id de la Lista que deseas eliminar. En la pestaña “Params”, introduce el id de la Lista que deseas eliminar como valor para la columna id.  Si la solicitud de eliminación se realiza correctamente, recibirás una respuesta similar al siguiente ejemplo: 
{
  "data": {
    "deleted": true
  }
}