Saltar al contenido principal

​
Introducción a los endpoints de consulta de Spaces

Esta guía rápida le ayudará a realizar su primera solicitud a uno de los endpoints de consulta de Spaces con un conjunto de fields especificados usando Postman. Si desea ver código de muestra en diferentes lenguajes de programación, visite nuestro repositorio X API v2 sample code GitHub.

​
Requisitos previos

Para completar esta guía, necesitará 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 obtenga 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 un lugar seguro.

​
Pasos para crear una solicitud de búsqueda de Spaces

Para este ejemplo, haremos una solicitud al endpoint de búsqueda de Spaces de usuario por creator ID, pero también puedes aplicar lo aprendido en esta guía rápida a otras solicitudes de búsqueda. 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 en tu entorno la colección de Postman de X API v2, 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 Spaces y encuentra la solicitud “Lookup Spaces created by one or more users”.   Paso dos: Autentica tu solicitud Para realizar correctamente una solicitud a la X API, debes verificar que tienes permiso. Para ello, este endpoint requiere que autentiques tu solicitud con OAuth 2.0 App-Only o Código de autorización de OAuth 2.0 con PKCE. Para simplificar, utilizaremos OAuth 2.0 App-Only con esta solicitud, pero deberás usar uno de los otros métodos de autenticación si deseas solicitar metrics privadas o Spaces de un usuario privado.  Para utilizar OAuth 2.0 App-Only, debes agregar tus keys and tokens, específicamente el App Access Token (también conocido como el App-only Bearer Token) a Postman. Puedes hacerlo seleccionando el entorno llamado “X API v2” en la esquina superior derecha de Postman y agregando tus keys and 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: Identifica y especifica de qué usuario deseas recuperar Posts Debes especificar un usuario para el cual deseas recuperar Spaces en vivo o próximos dentro de la solicitud. En este ejemplo, pasaremos un único user ID. Los user IDs son simplemente el valor numérico que representa el handle de una cuenta y que puedes encontrar en la URL del perfil de la cuenta. Por ejemplo, el username de la siguiente cuenta es XDevelopers. https://x.com/XDevelopers Para convertir este username al user ID, tendrás que usar el endpoint de búsqueda de usuario con el username y encontrar el user ID numérico en el payload. En el caso de @XDevelopers, el user ID es 2244994945. En Postman, navega a la pestaña “Params” e ingresa este user ID en la columna “Value” del parámetro id.
KeyValue
id2244994945
Paso cuatro: Identifica y especifica qué fields deseas recuperar Si haces clic en el botón “Send” después del paso tres, recibirás un id, que es el único campo del Space object devuelto de forma predeterminada en tu respuesta. Si deseas recibir fields adicionales, tendrás que especificarlos en tu solicitud con los parámetros space.fields o expansions. Para este ejercicio, solicitaremos tres conjuntos adicionales de fields de distintos objetos:
  • El field adicional title en el objeto principal de Spaces.
  • El user object completo del creator ID especificado
  • 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 key:value a la tabla “Query Params”:
KeyValueReturned fields
space.fieldstitlecreator_id
expansionscreator_idincludes.users.id, includes.users.name, includes.users.username
user.fieldscreated_atincludes.users.created_at
Ahora deberías ver la siguiente URL junto al botón “Send”: https://api.x.com/2/spaces/by/creator_ids?user_ids=2244994945&space.fields=creator_id&expansions=creator_id&user.fields=created_at Paso cinco: Realiza la solicitud y revisa la respuesta Una vez que esté todo configurado, haz clic en el botón “Send” y recibirás la siguiente respuesta: 
{
   "data": [
    {
        "creator_id": "2244994945",
        "id": "1zqKVXPQhvZJB",
        "title": "Hola mundo 👋",
        "state": "Running"
   },
   "includes": {
       "users": [
           {
               "created_at": "2013-12-14T04:35:55.000Z",
               "name": "Twitter Dev",
               "id": "2244994945",
               "username": "TwitterDev"
           }
       ]
   }
]
}
⌘I