コンテンツにスキップ

license_client.py リファレンス

アドオンにライセンス認証機能を追加するためのモジュールです。

設定ブロック

ファイル上部の設定ブロックを編集します。

ADDON_MODULE = "your_addon_folder"   # アドオンのフォルダ名(パッケージ名)← 必ず変更
ADDON_NAME   = "My Addon"            # アドオンの表示名
ADDON_ID     = 1                     # 管理画面のアドオンID
API_KEY      = "sk-xxxxxxxxxxxx"     # APIキー(API設定画面で発行)
API_BASE     = "https://example.com/api/v1"  # サーバーURL
CHECK_DAYS   = 30                    # ライセンス再確認間隔(日)

設定項目の詳細

ADDON_MODULE

アドオンのフォルダ名(Pythonパッケージ名)です。__name__ と同じ値を設定します。 ダウンロードしたままでは "your_addon_folder" になっています。必ず変更してください。

ADDON_NAME

アドオンの表示名です。サーバーにアドオンが未登録の場合、申請時にこの名前で自動作成されます。

ADDON_ID

管理画面の「アドオン管理」で確認できるID番号(整数)です。アドオン選択で自動入力されます。

API_KEY

API設定画面で「キーを再生成」して取得したキーです。ダウンロードファイルには含まれないため、手動で貼り付けてください。

API_BASE

このサーバーのベースURLです。ダウンロード時に自動入力されます。

CHECK_DAYS

Blender起動後、次にサーバーへライセンスを再確認するまでの間隔(日数)です。オフライン環境でも設定日数は使い続けられます。

公開関数

setup(on_activate, on_deactivate)

register() 内から呼びます。ライセンスUIの登録と起動時認証を行います。

引数 説明
on_activate 認証成功時・キャッシュ認証成功時に呼ばれる関数
on_deactivate ライセンス失効・期限切れ時に呼ばれる関数

teardown()

unregister() 内から呼びます。タイマーとUIクラスを解除します。

is_valid()

現在ライセンスが有効かどうかを返します(True / False)。

よくある質問

Q. オフライン環境でも使えますか? 一度認証するとローカルにキャッシュが保存されます。CHECK_DAYS の間はオフラインでも動作します。

Q. APIキーを再生成したらどうなりますか? キャッシュ期間中は引き続き使えますが、次回サーバー確認時にエラーになります。新しいキーを設定したアドオンを再配布する必要があります。

Q. アドオンが複数ある場合は? アドオンごとに license_client.py をダウンロードし、ADDON_IDADDON_NAMEADDON_MODULE を変えて使用してください。API_KEYAPI_BASE は共通で構いません。