Comenzar rápidamente

​

Introducción a los endpoints de búsqueda de Spaces

Esta guía de inicio rápido le ayudará a realizar su primera solicitud a uno de los endpoints de búsqueda de Spaces con un conjunto de fields especificados usando Postman.

Si desea ver código de ejemplo en distintos lenguajes de programación, visite nuestro repositorio de X API v2 sample code GitHub.

​

Requisitos previos

Para completar esta guía, necesitará un conjunto de claves y tokens para autenticar su solicitud. Puede generar estas claves y 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 necesarias. Asegúrese de guardar todas las credenciales en un lugar seguro.

​

Pasos para crear una solicitud de consulta de Spaces

Para este ejemplo, haremos una solicitud al endpoint de consulta de Spaces de usuario por ID de creador, pero también puedes aplicar lo aprendido en este inicio rápido a otras solicitudes de consulta.

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 cargada la colección de X API v2 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 métricas privadas o Spaces de un usuario privado.

Para utilizar OAuth 2.0 App-Only, debes agregar tus claves y tokens, específicamente el App Access Token (también conocido como el App-only Bearer Token) en Postman. Puedes hacerlo seleccionando el entorno llamado “X API v2” en la esquina superior derecha de Postman y agregando tus claves y 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 te gustaría recuperar Posts

Debes especificar un usuario del que te gustaría recuperar Spaces en vivo o programados dentro de la solicitud. En este ejemplo, pasaremos un único ID de usuario.

Los IDs de usuario son simplemente el valor numérico que representa un handle de cuenta y que puedes encontrar en la URL del perfil de una cuenta. Por ejemplo, el nombre de usuario de la siguiente cuenta es XDevelopers.

https://x.com/XDevelopers

Para convertir este nombre de usuario al ID de usuario, tendrás que usar el endpoint de consulta de usuario con el nombre de usuario y encontrar el ID de usuario numérico en el payload. En el caso de @XDevelopers, el ID de usuario es 2244994945.

En Postman, navega a la pestaña “Params” e ingresa este ID de usuario en la columna “Value” del parámetro id.

Key	Value
id	2244994945

Paso cuatro: Identifica y especifica qué fields te gustaría 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 por defecto 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 diferentes 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 en la tabla “Query Params”:

Key	Value	Returned fields
space.fields	title	creator_id
expansions	creator_id	includes.users.id, includes.users.name, includes.users.username
user.fields	created_at	includes.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: Envía tu solicitud y revisa la respuesta

Una vez que tengas 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": "En ejecución"
   },
   "includes": {
       "users": [
           {
               "created_at": "2013-12-14T04:35:55.000Z",
               "name": "Twitter Dev",
               "id": "2244994945",
               "username": "TwitterDev"
           }
       ]
   }
]
}