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 para explorar la funcionalidad de las APIs, así como para diagnosticar problemas con su aplicación.

Actualmente contamos con dos colecciones de Postman disponibles:

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, deberá asegurarse de contar con el acceso y las credenciales adecuados para la herramienta de la plataforma de desarrolladores de X que elija. Puede obtener más información sobre cómo obtener acceso en nuestra página “Introducción”.

Una vez que tenga una cuenta de desarrollador, haya configurado una App de desarrollador, disponga de un conjunto de autenticación keys and tokens, y haya configurado correctamente su entorno para realizar solicitudes a la API específica que planea utilizar, puede 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 crear los endpoints específicos que deseas usar en Postman, nosotros ya hicimos el trabajo por ti y preparamos una colección lista para usar con APIs relevantes. Solo haz clic en uno de los enlaces de la sección anterior “Postman collections” 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 configurado, por lo que solo necesitas agregar tus credenciales y los valores de los 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 keys and 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 keys and tokens. En este paso, te guiaremos por el proceso de agregar tus keys and tokens desde tu App de desarrollador al entorno ‘X API v2’.

Para agregar tus keys and tokens al entorno “X API v2”, haz clic en el botón “manage environments” en la esquina superior derecha de Postman; deberás hacer clic en el botón de configuración en la esquina superior derecha.

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

A continuación, agrega una variable para cada una de las distintas keys and tokens que generaste a través del 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 keys and tokens usadas en la tabla anterior son inventadas y no funcionarán si se usan en una solicitud.

Una vez que hayas agregado 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 del endpoint está configurada para heredar automáticamente las variables de este entorno.

Para usar Postman con Access Tokens de usuario, omite XXXX para ver los detalles adicionales sobre cómo hacerlo.

​

Paso tres: Seleccionar un endpoint 

El siguiente paso es elegir un endpoint de la colección y comenzar 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: Agregar valores en la pestaña Params

El siguiente paso es ir 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 query expansions y tweet.fields y agregar los siguientes valores:

Key	Value
tweet.fields	created_at,attachments
expansions	author_id

Además de agregar los parámetros de query, necesitamos añadir la Path Variable requerida, id. Dado que este endpoint devuelve Posts, debemos agregar un ID de Post válido como valor.

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

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

En la pestaña Params, desplázate hacia abajo más allá de todos los parámetros de query para mostrar la sección “Path Variables”. Añadiremos el ID de Post que deseas usar como valor de 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 la respuesta

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

Si todo se configuró correctamente, deberías recibir el siguiente payload:

{
    "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"
            }
        ]
    }
}

​

Generación de un Access Token de usuario con Postman:

​

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

Revisa el proceso de tres pasos descrito en la colección de prueba del flujo OAuth 1.0a.

​

Uso de OAuth 2.0 para generar un access token de usuario

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

Haga clic en la colección en su espacio de trabajo, vaya a la pestaña “Auth” y seleccione el type “OAuth 2.0”. Luego, bajo el encabezado “Configure New Token”, vaya a “Configuration Options”. Puede actualizar el “Grant Type” a “Authorization Code (With PKCE)”.

Deberá actualizar su Callback URL para que coincida con la callback url asociada a su aplicación. Además, actualice los siguientes parámetros:

• Auth URL - https://x.com/i/oauth2/authorize
• Access Token URL - https://api.x.com/2/oauth2/token
• Client ID - Su OAuth 2.0 client ID del Dev Portal
• Client Secret - Si utiliza un confidential client
• Update Scope - Scopes que coincidan con los endpoints a los que desea conectarse. Ejemplo “tweet.read users.read”
• Su callback URL (también conocida como redirect URL). Debe coincidir con lo que tiene en la configuración de autenticación de su App.
• State - state

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

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

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

​

Próximos pasos

Si hace clic en el botón de Postman que dice “Code”, puede convertir la solicitud que acabamos de crear al lenguaje de su preferencia, como Python, Node o Ruby, para empezar. Postman cuenta con excelente documentación que puede resultarle útil. También tenemos código de muestra en GitHub que puede ayudarle a integrarse con los endpoints más rápidamente.