Cómo conectarse a los endpoints usando el flujo de código de autorización (OAuth 2.0) con PKCE

​

Cómo conectarte a los endpoints con el flujo de código de autorización de OAuth 2.0 con PKCE

​

Cómo conectarse a los endpoints

Para autenticar a tus usuarios, tu App deberá implementar un flujo de autorización. Este flujo te permite enviar a tus usuarios a un cuadro de diálogo de autorización en X. Desde allí, la experiencia principal de X mostrará el cuadro de diálogo y gestionará la autorización en nombre de tu App. Tus usuarios podrán autorizar tu App o rechazar el permiso. Una vez que el usuario tome su decisión, X lo redirigirá a tu App, donde podrás intercambiar el código de autorización por un token de acceso (si el usuario autorizó tu App) o gestionar el rechazo (si no la autorizó).

​

Trabajo con clientes confidenciales

Si trabajas con clientes confidenciales, deberás usar un esquema de autenticación básica para generar un encabezado de autorización con codificación en base64 al realizar solicitudes a los endpoints de tokens.

El userid y la password se separan por un solo carácter de dos puntos (”:”) dentro de una cadena codificada en base64 en las credenciales.

Un ejemplo se vería así:

-header 'Authorization: Basic V1ROclFTMTRiVWhwTWw4M2FVNWFkVGQyTldNNk1UcGphUTotUm9LeDN4NThKQThTbTlKSXQyZm1BanEzcTVHWC1icVozdmpKeFNlR3NkbUd0WEViUA=='

Si el agente de usuario desea enviar el Client ID “Aladdin” y la contraseña “open sesame”, usaría el siguiente campo de encabezado:

Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Para crear el encabezado de autorización básica, deberás aplicar codificación en base64 a tu Client ID y Client Secret, que puedes obtener en la página “Keys and Tokens” de tu App dentro del Portal de desarrolladores.

​

Pasos para conectarte con OAuth 2.0

Paso 1: Construir una URL de autorización

Tu App deberá construir una URL de autorización a X, indicando los scopes que tu App necesita autorizar. Por ejemplo, si tu App necesita consultar Tweets, usuarios y gestionar follows, debería solicitar los siguientes scopes:

tweet.read%20users.read%20follows.read%20follows.write

La URL también incluirá los parámetros code_challenge y state, además de los demás parámetros requeridos. En producción, deberías usar una cadena aleatoria para el code_challenge.

Paso 2: GET oauth2/authorize

Haz que el usuario se autentique y envíe a la aplicación un código de autorización. Si has habilitado OAuth 2.0 para tu App, puedes encontrar tu Client ID en la página “Keys and Tokens” de tu App.

Un ejemplo de URL a la que redirigir al usuario sería:

https://x.com/i/oauth2/authorize?response_type=code&client_id=M1M5R3BMVy13QmpScXkzTUt5OE46MTpjaQ&redirect_uri=https://www.example.com&scope=tweet.read%20users.read%20follows.read%20follows.write&state=state&code_challenge=challenge&code_challenge_method=plain

Un ejemplo de URL con offline_access tendría el siguiente aspecto:

https://x.com/i/oauth2/authorize?response_type=code&client_id=M1M5R3BMVy13QmpScXkzTUt5OE46MTpjaQ&redirect_uri=https://www.example.com&scope=tweet.read%20users.read%20follows.read%20offline.access&state=state&code_challenge=challenge&code_challenge_method=plain

Tras una autenticación exitosa, en el redirect_uri recibirías una solicitud que contiene el parámetro auth_code. Tu App debe verificar el parámetro state.

Un ejemplo de solicitud desde la redirección del cliente sería:

https://www.example.com/?state=state&code=VGNibzFWSWREZm01bjN1N3dicWlNUG1oa2xRRVNNdmVHelJGY2hPWGxNd2dxOjE2MjIxNjA4MjU4MjU6MToxOmFjOjE

Paso 3: POST oauth2/token - Token de acceso

En este punto, puedes usar el código de autorización para crear un token de acceso y un token de actualización (solo si se solicitó el ámbito offline.access). Puedes realizar una solicitud POST al siguiente endpoint:

https://api.x.com/2/oauth2/token

Deberás incluir el Content-Type application/x-www-form-urlencoded en un encabezado. Además, tu solicitud debe incluir: code, grant_type, client_id y redirect_uri, así como code_verifier.

Aquí tienes un ejemplo de solicitud de token para un cliente público:

curl --location --request POST 'https://api.x.com/2/oauth2/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'code=VGNibzFWSWREZm01bjN1N3dicWlNUG1oa2xRRVNNdmVHelJGY2hPWGxNd2dxOjE2MjIxNjA4MjU4MjU6MToxOmFjOjE' \
--data-urlencode 'grant_type=authorization_code' \
--data-urlencode 'client_id=rG9n6402A3dbUJKzXTNX4oWHJ' \
--data-urlencode 'redirect_uri=https://www.example.com' \
--data-urlencode 'code_verifier=challenge'

Aquí tienes un ejemplo con un cliente confidencial:

curl --location --request POST 'https://api.x.com/2/oauth2/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic V1ROclFTMTRiVWhwTWw4M2FVNWFkVGQyTldNNk1UcGphUTotUm9LeDN4NThKQThTbTlKSXQyZm1BanEzcTVHWC1icVozdmpKeFNlR3NkbUd0WEViUA=='\
--data-urlencode 'code=VGNibzFWSWREZm01bjN1N3dicWlNUG1oa2xRRVNNdmVHelJGY2hPWGxNd2dxOjE2MjIxNjA4MjU4MjU6MToxOmFjOjE' \
--data-urlencode 'grant_type=authorization_code' \
--data-urlencode 'redirect_uri=https://www.example.com' \
--data-urlencode 'code_verifier=challenge'

Paso 4: Conéctate a las API

Ahora estás listo para conectarte a los endpoints con OAuth 2.0. Para hacerlo, harás la solicitud a la API igual que con la autenticación con token Bearer. En lugar de enviar tu token Bearer, deberás usar el token de acceso que generaste en el paso anterior. Como respuesta, deberías recibir la carga útil correspondiente al endpoint que estés solicitando. Esta solicitud es la misma tanto para clientes públicos como para clientes confidenciales.

Un ejemplo de la solicitud que harías sería el siguiente:

curl --location --request GET 'https://api.x.com/2/tweets?ids=1261326399320715264,1278347468690915330' \
--header 'Authorization: Bearer Q0Mzb0VhZ0V5dmNXSTEyNER2MFNfVW50RzdXdTN6STFxQlVkTGhTc1lCdlBiOjE2MjIxNDc3NDM5MTQ6MToxOmF0OjE'

Paso 5: POST oauth2/token - refresh token

Un refresh token permite que una aplicación obtenga un nuevo access token sin pedir interacción del usuario. Puedes crear un refresh token realizando una solicitud POST al siguiente endpoint: https://api.x.com/2/oauth2/token. Deberás agregar el encabezado Content-Type con el valor application/x-www-form-urlencoded. Además, deberás incluir tu refresh_token, establecer grant_type como refresh_token y definir tu client_id.

Esta solicitud funcionará para clientes públicos:

POST 'https://api.x.com/2/oauth2/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'refresh_token=bWRWa3gzdnk3WHRGU1o0bmRRcTJ5VUxWX1lZTDdJSUtmaWcxbTVxdEFXcW5tOjE2MjIxNDc3NDM5MTQ6MToxOnJ0OjE' \
--data-urlencode 'grant_type=refresh_token' \
--data-urlencode 'client_id=rG9n6402A3dbUJKzXTNX4oWHJ'

A continuación se muestra un ejemplo para clientes confidenciales:

POST 'https://api.x.com/2/oauth2/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic V1ROclFTMTRiVWhwTWw4M2FVNWFkVGQyTldNNk1UcGphUTotUm9LeDN4NThKQThTbTlKSXQyZm1BanEzcTVHWC1icVozdmpKeFNlR3NkbUd0WEViUA=='\
--data-urlencode 'refresh_token=bWRWa3gzdnk3WHRGU1o0bmRRcTJ5VUxWX1lZTDdJSUtmaWcxbTVxdEFXcW5tOjE2MjIxNDc3NDM5MTQ6MToxOnJ0OjE'\
--data-urlencode 'grant_type=refresh_token'

Paso 6: POST oauth2/revoke - Revocar el token

Un token de revocación invalida un token de acceso o un token de actualización. Se usa para habilitar una función de “cerrar sesión” en los clientes, permitiéndote eliminar cualquier credencial de seguridad asociada con el flujo de autorización que ya no sea necesaria. El token de revocación es para que una App revoque un token y no a un usuario. Puedes crear una solicitud de revocación haciendo una solicitud POST a la siguiente URL si la App desea revocar de forma programática el acceso que se le otorgó:

https://api.x.com/2/oauth2/revoke

Deberás incluir el Content-Type application/x-www-form-urlencoded en un encabezado, junto con tu token y tu client_id.

En algunos casos, un usuario puede querer revocar el acceso concedido a una App; puede hacerlo visitando la página de Apps conectadas.

curl --location --request POST 'https://api.x.com/2/oauth2/revoke' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'token=Q0Mzb0VhZ0V5dmNXSTEyNER2MFNfVW50RzdXdTN6STFxQlVkTGhTc1lCdlBiOjE2MjIxNDc3NDM5MTQ6MToxOmF0OjE' \
--data-urlencode 'client_id=rG9n6402A3dbUJKzXTNX4oWHJ'

Esta solicitud funcionará para clientes confidenciales:

curl --location --request POST 'https://api.x.com/2/oauth2/revoke' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic V1ROclFTMTRiVWhwTWw4M2FVNWFkVGQyTldNNk1UcGphUTotUm9LeDN4NThKQThTbTlKSXQyZm1BanEzcTVHWC1icVozdmpKeFNlR3NkbUd0WEViUA=='\
--data-urlencode 'token=Q0Mzb0VhZ0V5dmNXSTEyNER2MFNfVW50RzdXdTN6STFxQlVkTGhTc1lCdlBiOjE2MjIxNDc3NDM5MTQ6MToxOmF0OjE'