Introducción a 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 te permite realizar solicitudes a una API desde una interfaz gráfica de usuario. Recomendamos usar Postman con X API, X Ads API y los endpoints de Labs cuando explores la funcionalidad de las APIs, así como cuando soluciones problemas con tu aplicación. 

Actualmente tenemos 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ás asegurarte de que tienes el acceso y las credenciales adecuados para la herramienta de la plataforma para desarrolladores de X que prefieras. Puedes obtener más información sobre cómo obtener acceso en nuestra página “Introducción”. 

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.  

Primeros pasos con las colecciones de Postman de X

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

Aunque podrías crear manualmente los endpoints específicos que quieras usar dentro de Postman, nosotros hicimos todo el trabajo pesado por ti y creamos una colección lista para usar con las APIs relevantes. Solo haz clic en uno de los enlaces de la sección anterior “Postman collections” y se agregará a tu app de Postman una colección con todos los endpoints asociados con 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 ya configurado, así que solo necesitas agregar tus credenciales y los valores de los parámetros para empezar a explorar su funcionalidad.

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

Paso dos: añade tus claves y tokens como variables de entorno

Cuando añadas la colección a tu instancia de Postman, se añadirá automáticamente un entorno llamado “X API v2”, al que tendrás que 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 añadir 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, añade una variable en la tabla para cada una de las distintas claves y tokens que hayas generado en el panel de Apps. Aquí tienes un ejemplo de cómo debería verse tu tabla:

VARIABLE	INITIAL VALUE	CURRENT VALUE
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 usados en la tabla anterior son ficticios y no funcionarán si se utilizan 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 hacer solicitudes a la colección de X API v2. Esto se debe a que todas las pestañas de autorización de los endpoints están configuradas para heredar automáticamente las variables de este entorno.

Para usar Postman con User Access Tokens, 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 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: Añade valores a la pestaña Params

En este paso, deberás 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 pasar en tu solicitud. 

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

Key	Value
tweet.fields	created_at,attachments
expansions	author_id

Además de añadir los parámetros de consulta, debemos añadir la variable de ruta obligatoria, id. Como este endpoint devuelve Publicaciones, necesitamos añadir un ID de la Publicación válido como valor.

Puedes encontrar el ID de la Publicación yendo a x.com, haciendo clic en una Publicación y luego buscando en la URL. Por ejemplo, el ID de la Publicación 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 consulta hasta mostrar la sección “Path Variables”. Añadiremos el ID de la Publicación que quieres usar como valor para la clave id.

Si has introducido todo correctamente en este paso, la pestaña Params debería verse como en el siguiente ejemplo:

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

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

Si todo se configuró correctamente, deberías recibir el siguiente cuerpo de la respuesta:

{
    "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": "Developers",
                "id": "2244994945"
            }
        ]
    }
}

Generar un token de acceso de usuario con Postman:

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

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

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

Si quieres generar un token de acceso de usuario OAuth 2.0 en Postman, puedes generar tokens de acceso OAuth 2.0 para usarlos junto con la X API v2 Postman collection de X. 

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 ahí, bajo el encabezado “Configure New Token”, ve a donde dice “Configuration Options”. Puedes actualizar el “Grant Type” a “Authorization Code (With PKCE)”.

Deberás actualizar tu Callback URL para que coincida con la callback URL 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 id de cliente 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 quieras conectarte. Ejemplo: “tweet.read users.read” 
• Tu Callback URL (también conocida como redirect URL). Debe coincidir con lo que tienes en la configuración de autenticación de tu App.
• State - state

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

Después de autorizar tu app, se te redirigirá de vuelta a Postman, donde podrás ver tu token y seleccionar el botón “Use Token” para empezar a hacer solicitudes en nombre de un usuario autorizado.

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

Qué sigue a continuación

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