Primeros pasos con Postman

En este tutorial, veremos qué es Postman y cómo configurarlo rápidamente.

​

Introducción

Postman es una aplicación de escritorio y web que permite realizar solicitudes a una API desde una interfaz gráfica. Recomendamos usar Postman con la X API, la X Ads API y los endpoints de Labs al explorar la funcionalidad de las APIs, así como para solucionar problemas con tu aplicación. 

Actualmente tenemos disponibles dos colecciones de Postman:

Colección de X API v2

Colección de X Ads API

​

Requisitos previos

Antes de comenzar a usar las colecciones de Postman de X, asegúrate de contar con el acceso y las credenciales adecuados para la herramienta de la plataforma de desarrolladores de X que elijas. Puedes obtener más información sobre cómo obtener acceso en nuestra página “Primeros pasos”.

Una vez que tengas una cuenta de desarrollador, hayas configurado una App de desarrollador y cuentes con un conjunto de claves y tokens de Autenticación, y hayas configurado correctamente tu entorno para realizar solicitudes a la API específica que planeas usar, puedes seguir los pasos a continuación para comenzar.  

​

Introducción a las colecciones de Postman de X

​

Paso uno: Agrega una de las colecciones de Postman de X a tu cuenta

Aunque podrías configurar en Postman los endpoints específicos que deseas usar, nosotros ya hicimos ese trabajo por ti y preparamos una colección lista para usar con las APIs relevantes. Solo haz clic en uno de los enlaces de la sección anterior “Colecciones de Postman” y se añadirá a tu app de Postman una colección con todos los endpoints asociados a la API seleccionada. Estas colecciones también están disponibles en la Postman API Network. Cada endpoint incluirá automáticamente los parámetros disponibles, respuestas de ejemplo y el tipo de Autenticación preconfigurado, así que solo necesitas añadir tus credenciales y valores de parámetros para empezar a explorar la funcionalidad.

En este ejemplo, vamos a trabajar con la colección de la API v2 de X.   

​

Paso dos: agrega tus claves y tokens como variables de entorno

Cuando agregues la colección a tu instancia de Postman, se añadirá automáticamente un entorno llamado “X API v2”, al cual deberás agregar tus claves y tokens. En este paso, te guiaremos por el proceso de añadir tus claves y tokens desde tu App de desarrollador al entorno “X API v2”. 

Para agregar tus claves y tokens al entorno “X API v2”, haz clic en el botón “manage environments” en la esquina superior derecha de Postman.   

En la lista de entornos, haz clic en “X API v2”. 

A continuación, agrega una variable para todas las diferentes claves y tokens que hayas generado mediante el panel de Apps en la tabla. Aquí tienes un ejemplo de cómo debería verse tu tabla:

VARIABLE	VALOR INICIAL	VALOR ACTUAL
consumer_key	QAktM6W6DF6F7XXXXXX	QAktM6W6DF6F7XXXXXX
consumer_secret	AJX560A2Omgwyjr6Mml2esedujnZLHXXXXXX	AJX560A2Omgwyjr6Mml2esedujnZLHXXXXXX
access_token	1995XXXXX-0NGqVhk3s96IX6SgT3H2bbjOPjcyQXXXXXXX	1995XXXXX-0NGqVhk3s96IX6SgT3H2bbjOPjcyQXXXXXXX
token_secret	rHVuh7dgDuJCOGeoe4tndtjKwWiDjBZHLaZXXXXXX	rHVuh7dgDuJCOGeoe4tndtjKwWiDjBZHLaZXXXXXX
bearer_token	AAAAAAAAAAAAAAAAAAAAAL9v6AAAAAAA99t03huuqRYg0mpYAAFRbPR3XXXXXXX	AAAAAAAAAAAAAAAAAAAAAL9v6AAAAAAA99t03huuqRYg0mpYAAFRbPR3XXXXXXX

Ten en cuenta que las claves y tokens utilizados en la tabla anterior son ficticios y no funcionarán si se usan en una solicitud. 

Una vez que hayas añadido tus credenciales como variables y te hayas asegurado de que el entorno X API v2 esté seleccionado, estarás listo para realizar solicitudes a la colección de X API v2. Esto se debe a que cada una de las pestañas de autorización de los endpoints está configurada para heredar automáticamente las variables de este entorno. 

Para usar Postman con tokens de acceso de usuario, salta a XXXX para ver detalles adicionales sobre cómo hacerlo.

​

Paso tres: Selecciona un endpoint 

El siguiente paso es elegir un endpoint de la colección y empezar a construir tu solicitud. Puedes seleccionar un endpoint desde la navegación del lado derecho. Así es como se ve:

Para este ejemplo, vamos a usar el endpoint X API v2 > Post Lookup > Single Post. 

​

Paso cuatro: Agrega valores a la pestaña Params

El siguiente paso te llevará a la pestaña Params. Deberías ver un conjunto de parámetros inactivos con descripciones que explican qué hace cada parámetro y una lista de todos los valores posibles que puedes enviar con tu solicitud. 

En este ejemplo, vamos a activar los parámetros de consulta expansions y tweet.fields y agregar los siguientes valores:

Clave	Valor
tweet.fields	created_at,attachments
expansions	author_id

Además de agregar los parámetros de consulta, necesitamos agregar la Variable de ruta obligatoria, id. Dado que este endpoint devuelve Posts, debemos agregar un Post ID válido como valor.

Puedes encontrar el Post ID navegando a x.com, haciendo clic en un Post y luego mirando la URL. Por ejemplo, el Post ID de la siguiente URL es 1228393702244134912:

https://x.com/XDevelopers/status/1228393702244134912

En la pestaña Params, desplázate más allá de todos los parámetros de consulta para mostrar la sección “Path Variables”. Agregaremos el Post ID que te gustaría usar como valor para la clave id.

Si ingresaste todo correctamente en este paso, la pestaña Params debería verse como lo siguiente:

​

Paso cinco: Envía tu solicitud y revisa tu respuesta

Ahora que todo está configurado en tu solicitud, puedes hacer clic en el botón “Send”. 

Si todo está configurado correctamente, deberías recibir la siguiente carga útil:

{
    "data": {
        "author_id": "2244994945",
        "text": "¿Qué escribió el desarrollador en su tarjeta de San Valentín?\n  \nwhile(true) {\n    I = Love(You);  \n}",
        "id": "1228393702244134912",
        "created_at": "2020-02-14T19:00:55.000Z"
    },
    "includes": {
        "users": [
            {
                "username": "XDevelopers",
                "name": "Desarrolladores",
                "id": "2244994945"
            }
        ]
    }
}

​

Generar un token de acceso de usuario con Postman:

​

Uso de OAuth 1.0a para generar un token de acceso de usuario

Repasa el proceso de tres pasos que se utiliza en la colección de pruebas del flujo OAuth 1.0a.

​

Uso de OAuth 2.0 para generar un token de acceso de usuario

Si deseas generar un token de acceso de usuario de OAuth 2.0 en Postman, puedes generar tokens de acceso de OAuth 2.0 para usarlos junto con la colección de Postman de X API v2. 

Haz clic en la colección en tu espacio de trabajo, ve a la pestaña titulada “Auth” y selecciona el tipo “OAuth 2.0”. Desde allí, bajo el encabezado “Configure New Token”, ve a “Configuration Options”. Puedes actualizar el “Grant Type” a “Authorization Code (With PKCE)”.

Deberás actualizar tu URL de retorno (Callback URL) para que coincida con la URL de retorno asociada con tu aplicación. Además, deberás actualizar los siguientes parámetros:

• Auth URL -  https://x.com/i/oauth2/authorize
• Access Token URL -  https://api.x.com/2/oauth2/token
• Client ID - Tu Client ID de OAuth 2.0 del Dev Portal
• Client Secret - Si estás usando un cliente confidencial
• Update Scope - Scopes que coincidan con los endpoints a los que quieres conectarte. Ejemplo “tweet.read users.read” 
• Tu URL de retorno (también conocida como URL de redirección). Debe coincidir con lo que tienes en la configuración de Autenticación de tu App.
• State - state

Cuando estés listo, haz clic en “Get New Access Token” para generar un token de acceso. Si ves un cuadro de diálogo que indica que algo salió mal, quizá necesites presionar el botón Atrás para iniciar sesión. Deberás autorizar tu App para que tenga acceso a tu cuenta haciendo clic en “Authorize app” en el cuadro de diálogo.

Después de autorizar tu App, regresarás a Postman, donde podrás ver tu token y seleccionar el botón “Use Token” para comenzar a realizar solicitudes en nombre de un usuario autorizado.

Ya estás listo para usar la colección de Postman.

​

Qué sigue

Si haces clic en el botón de Postman que dice “Code”, puedes convertir la solicitud que acabamos de crear al lenguaje de tu elección, como Python, Node o Ruby, para empezar. Postman tiene excelente documentación que puede serte útil. También contamos con código de ejemplo en GitHub que puede ayudarte a integrarte con los endpoints más rápidamente.