設定
Satcat SDKの設定(認証情報やタイムアウトなど)は、3つの方法でできます。
設定ファイル内で設定する
ほとんどのユーザーに推奨されるのは、JSON形式のファイルを使用する方法です。このファイルに値を記入することで、satcat.sdk.settings
モジュールで公開されている全ての設定項目を指定できます。
デフォルトでは、SDKは現在のディレクトリにある config.json
ファイルを自動的に読み込みます。別のファイルを読み込ませたい場合は、シェル環境変数SATCAT_CONFIG_PATH
にファイルパスを指定してください。
config.json
ファイル内では、satcat.sdk.settings
に含まれる任意の項目を設定できます。例えば、auth_client_id
とauth_client_secret
を設定する場合、次のように記述します。
{
"auth_client_id": "<api key client id>"
"auth_client_secret": "<api key secret>"
}
環境変数を用いて設定する
satcat.sdk.settings
内の設定項目は、環境変数を使用して設定することもできます。設定する場合は、設定名を大文字にし、先頭にSATCAT_
を付けた環境変数を定義します。例えば、auth_client_id
とauth_client_secret
を環境変数で設定する場合、次のように指定します。
SATCAT_AUTH_CLIENT_ID="<api key client id>"
SATCAT_AUTH_CLIENT_SECRET="<api key client secret>"
Pythonスクリプトで設定する
Satcat SDKを使用するPythonスクリプト内で、実行時に satcat.sdk.settings
内の項目を直接設定することもできます。例えば、auth_client_id
とauth_client_secret
を設定するには、次のように記述します。
satcat.sdk.settings.settings.auth_client_id = "<api key client id>"
satcat.sdk.settings.settings.auth_client_secret = "<api key client secret>"
認証
Satcat SDKは Satcat APIスイートのクライアントライブラリであるため、Satcat SDKを使用するにはSatcatプラットフォームへの認証が必要です。認証にはAPIキーが必要になり、Control Centerで作成および管理できます。
API キーを Satcat SDK に接続するには、以下の設定を使用します。
settings.auth_method = "client_credentials"
settings.auth_id = "<your client id>"
settings.auth_secret = "<your client secret>"