Passer au contenu principal
Ce module fournit des fonctionnalités d’authentification OAuth 1.0a pour des flux d’autorisation sécurisés. Il gère la génération de jetons de requête, la création d’URL d’autorisation, l’échange de jetons d’accès et la génération de signatures OAuth 1.

class xdk.oauth1_auth.OAuth1

Gestionnaire d’authentification OAuth1 pour X API.

Paramètres

str
str
str
str or None
défaut:"None"
str or None
défaut:"None"

__init__

Initialise l’authentification OAuth1.

Paramètres

str
Clé API (Consumer Key).
str
Secret d’API (Consumer Secret).
str
URL de rappel pour le flux OAuth.
str or None
défaut:"None"
Access Token (si déjà obtenu).
str or None
défaut:"None"
Secret de l’Access Token (si déjà obtenu).

build_request_header

Construit l’en-tête d’autorisation OAuth1 pour les requêtes adressées à l’API.

Paramètres

str
Méthode HTTP (GET, POST, etc.).
str
URL de la requête (peut inclure des paramètres de requête).
str
défaut:"''"
Corps de la requête (chaîne encodée de type formulaire ou vide).

Retourne

str

get_access_token

Échange le verifier contre un jeton d’accès.

Paramètres

str
Paramètre oauth_verifier issu du callback ou du code PIN.

Renvoie

OAuth1AccessToken

get_authorization_url

Obtenir l’URL d’autorisation pour le flux OAuth1.

Paramètres

bool
défaut:"False"
Indique s’il faut utiliser le flux d’authentification « Log in with X ».

Renvoie

str

get_request_token

Récupère un jeton de requête pour initier le flux OAuth1. :returns: Renvoie un jeton de requête contenant oauth_token et oauth_token_secret. :rtype: OAuth1RequestToken

Retourne

OAuth1RequestToken

start_oauth_flow

Méthode utilitaire permettant d’initier le flux OAuth1.

Paramètres

bool
défaut:"False"
Indique s’il faut utiliser le flux d’authentification « Log in with X ».

Renvoie

str

class xdk.oauth1_auth.OAuth1AccessToken

Réponse contenant un jeton d’accès OAuth1.

Paramètres

str
str

__init__

Initialise le jeton d’accès OAuth1.

Paramètres

str
Le jeton d’accès.
str
Le secret du jeton d’accès.

class xdk.oauth1_auth.OAuth1RequestToken

Réponse contenant le jeton de requête OAuth1.

Paramètres

str
str

__init__

Initialise le jeton de requête OAuth1.

Paramètres

str
Le jeton OAuth.
str
Le secret du jeton OAuth.