Saltar al contenido principal

​
Introducción al grupo de endpoints para administrar Lists

Este breve resumen le ayudará a realizar su primera solicitud a los endpoints para administrar Lists mediante Postman. Si desea ver código de muestra en diferentes lenguajes, visite nuestro repositorio de GitHub de X API v2 sample code. Nota: Para este ejemplo, haremos una solicitud al endpoint Create a List, pero también puede aplicar lo aprendido en esta Guía rápida a otras solicitudes de administración.
Requisitos previosPara 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 administración de List

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 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 cargada en Postman la colección de X API v2, navegue a la carpeta “List”, seleccione la carpeta “Manage List” y luego elija “Create a List”. Paso dos: autentique su solicitud Para realizar correctamente una solicitud a la X API, debe verificar que tiene permiso para hacerlo. Para ello, con los endpoints de administración de Posts, debe autenticar su solicitud usando OAuth 1.0a User Context o OAuth 2.0 Authorization Code with PKCE. En este ejemplo, vamos a usar OAuth 1.0a User Context. Debe agregar 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 agregando sus keys and tokens a los campos “initial value” y “current value” (haciendo clic en el ícono de ojo junto al menú desplegable de entornos). Si lo ha hecho correctamente, estas variables se incorporarán automáticamente en la pestaña de autorización de la solicitud.   Paso tres: especifique el nombre para la nueva List Al crear una nueva List con este endpoint, el nombre de la List es un parámetro obligatorio del cuerpo. Opcionalmente, puede proporcionar una descripción y especificar si la List es privada. En Postman, navegue a la pestaña “Body” e ingrese el nombre de la List como valor del parámetro name. Además, si desea agregar una descripción para la List, simplemente agregue una nueva clave etiquetada description del mismo modo que name, seguida de la descripción de la List como valor. Hacer que una List sea privada seguirá 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ía ver una URL similar junto al botón “Send”: https://api.x.com/2/lists Step four: Make your request and review your response Una vez que tenga todo configurado, presione el botón “Send” y recibirá una respuesta similar al siguiente ejemplo de respuesta: 
{
  "data": {
    "id": "1441162269824405510",
    "name": "Nueva lista creada desde Postman"
  }
}
Si el objeto de respuesta devuelto contiene un id y el nombre de tu List, has creado correctamente la List.  Para eliminar una List, selecciona la solicitud “Delete a List”, que también se encuentra en la carpeta “Lists” de la colección X API v2 cargada en Postman. Este endpoint requiere el id de la List que deseas eliminar. En la pestaña “Params”, ingresa el id de la List que deseas eliminar como valor en la columna id.  Si la solicitud DELETE se realiza correctamente, recibirás una respuesta similar al siguiente ejemplo: 
{
  "data": {
    "deleted": true
  }
}
⌘I