Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://generaltranslation.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Este módulo proporciona funcionalidad de autenticación OAuth2 con PKCE (Proof Key for Code Exchange) para flujos de autorización seguros. Incluye la generación de verificadores de código, la gestión de tokens y la actualización automática de tokens.

​
class xdk.oauth2_auth.OAuth2PKCEAuth

Autenticación OAuth2 PKCE para la X API.

​
Parámetros

​
path.base_url
str
predeterminado:"'https://api.x.com'"
​
path.authorization_base_url
str
predeterminado:"'https://x.com/i'"
​
path.client_id
str or None
predeterminado:"None"
​
path.client_secret
str or None
predeterminado:"None"
​
path.redirect_uri
str or None
predeterminado:"None"
​
path.token
Dict[str, Any] or None
predeterminado:"None"
​
path.scope
str or List[str] or None
predeterminado:"None"

​
__init__

Inicializa la autenticación OAuth2 con PKCE.

​
Parámetros

​
path.base_url
str
predeterminado:"'https://api.x.com'"
La URL base para el endpoint de tokens de X API (valor predeterminado: https://api.x.com).
​
path.authorization_base_url
str
predeterminado:"'https://x.com/i'"
La URL base para la autorización OAuth2 (valor predeterminado: https://x.com/i).
​
path.client_id
str or None
predeterminado:"None"
El client ID para X API.
​
path.client_secret
str or None
predeterminado:"None"
El client secret para X API.
​
path.redirect_uri
str or None
predeterminado:"None"
La URI de redirección para la autorización OAuth2.
​
path.token
Dict[str, Any] or None
predeterminado:"None"
Un diccionario de tokens OAuth2 existente (si está disponible).
​
path.scope
str or List[str] or None
predeterminado:"None"
Cadena separada por espacios o lista de cadenas para los ámbitos de autorización OAuth2.

​
exchange_code

Intercambia un código de autorización por tokens (coincide con la API de TypeScript).

​
Parámetros

​
path.code
str
El código de autorización recibido en el callback.
​
path.code_verifier
str or None
predeterminado:"None"
Verificador de código opcional (usa el verificador almacenado si no se proporciona).

​
Devuelve

Dictstr, Any

​
fetch_token

Obtiene el token mediante la URL de respuesta de autorización (método heredado, usa exchange_code internamente).

​
Parámetros

​
path.authorization_response
str
La URL de redirección completa recibida tras la autorización

​
Devuelve

Dictstr, Any

​
get_authorization_url

Obtiene la URL de autorización para el flujo PKCE de OAuth 2.0.

​
Parámetros

​
path.state
str or None
predeterminado:"None"
Parámetro opcional de estado (state) para mayor seguridad.

​
Devuelve

str

​
get_code_challenge

Devuelve el code challenge actual (para PKCE). :returns: El code challenge actual, o None si no está definido. :rtype: Optional[str]

​
Devuelve

str | None

​
get_code_verifier

Obtiene el verificador de código actual (para PKCE). :returns: El verificador de código actual o None si no está establecido. :rtype: Optional[str]

​
Devuelve

str | None

​
is_token_expired

Comprueba si el token ha caducado. :returns: True si el token ha caducado, False en caso contrario. :rtype: bool

​
Devuelve

bool

​
refresh_token

Actualiza el token de acceso. :returns: El diccionario de token renovado :rtype: Dict[str, Any]

​
Devuelve

Dictstr, Any

​
set_pkce_parameters

Configura manualmente los parámetros PKCE.

​
Parámetros

​
path.code_verifier
str
El code_verifier que se va a utilizar.
​
path.code_challenge
str or None
predeterminado:"None"
code_challenge opcional (se generará si no se proporciona).