Skip to main content
このモジュールは、安全な認可フローのための OAuth 1.0a 認証機能を提供します。リクエストトークンの生成、認可 URL の生成、アクセストークンの交換、および OAuth 1.0a シグネチャの生成を行います。

​
class xdk.oauth1_auth.OAuth1

X API 向けの OAuth1 認証ハンドラーです。

​
パラメータ

​
str
​
str
​
str
​
str or None
デフォルト:"None"
​
str or None
デフォルト:"None"

​
__init__

OAuth1 認証を初期化します。

​
パラメーター

​
str
API Key（Consumer Key）。
​
str
API Secret（Consumer Secret）。
​
str
OAuth フロー用のコールバック URL。
​
str or None
デフォルト:"None"
Access Token（既に取得済みの場合）。
​
str or None
デフォルト:"None"
Access Token Secret（既に取得済みの場合）。

​
build_request_header

API リクエスト用の OAuth1 認可ヘッダーを生成します。

​
パラメータ

​
str
HTTP メソッド (GET、POST など)。
​
str
リクエスト URL（クエリパラメータを含む場合があります）。
​
str
デフォルト:"''"
リクエストボディ（フォームエンコード形式の文字列、または空）。

​
戻り値

str

​
get_access_token

verifier をアクセストークンに交換します。

​
パラメーター

​
str
コールバックまたは PIN から取得した OAuth verifier。

​
戻り値

OAuth1AccessToken

​
get_authorization_url

OAuth1 フローの認可 URL を取得します。

​
パラメーター

​
bool
デフォルト:"False"
「Log in with X」フローを使用するかどうかを指定します。

​
戻り値

str

​
get_request_token

OAuth1 フローを開始するためのリクエストトークンを取得します。 :returns: oauth_token と oauth_token_secret を含むリクエストトークンを返します。 :rtype: OAuth1RequestToken

​
戻り値

OAuth1RequestToken

​
start_oauth_flow

OAuth1 フローを開始するための補助メソッドです。

​
パラメーター

​
bool
デフォルト:"False"
「Log in with X」フローを使用するかどうかを示します。

​
戻り値

str

​
class xdk.oauth1_auth.OAuth1AccessToken

OAuth1 アクセストークンのレスポンス。

​
パラメータ

​
str
​
str

​
__init__

OAuth1 アクセストークンを初期化します。

​
パラメータ

​
str
アクセストークン。
​
str
アクセストークンシークレット。

​
class xdk.oauth1_auth.OAuth1RequestToken

OAuth1 リクエストトークンのレスポンス。

​
パラメータ

​
str
​
str

​
__init__

OAuth1 のリクエストトークンを初期化します。

​
パラメータ

​
str
OAuth トークン。
​
str
OAuth トークンのシークレット。