ライセンス管理の始め方¶
新しいアドオンのライセンス管理を始める手順です。
ステップ 1:アドオンを登録する¶
- 左メニュー「アドオン管理」を開く
- 右上の「+アドオンを追加」をクリック
- アドオン名・バージョン・説明を入力して保存
- 発行された ID を控えておく
アドオンを先に登録する
license_client.py をダウンロードする前に、必ずアドオンを登録してIDを確認してください。ダウンロードフォームでアドオンを選択するとIDが自動入力されます。
ステップ 2:APIキーを取得する¶
- 左メニュー「API設定」を開く(オーナーのみ)
- APIキーがまだない場合は「キーを再生成」をクリックして発行する
- 表示された
sk-xxxx...のキーを安全な場所にコピーする
キーは一度しか表示されません
APIキーはハッシュ値でのみ保存されるため、画面を閉じると元のキーは取り出せません。必ずコピーして保管してください。
キーの再生成は慎重に
一度設定したキーは変えないのが基本です。再生成すると、そのキーを埋め込んだすべての配布済みアドオンが次回サーバー確認時に認証エラーになります。再生成した場合は新しいキーを設定したアドオンを再配布する必要があります。
ステップ 3:license_client.py をダウンロードする¶
- 「API設定」ページ下部の「license_client.py ダウンロード」セクションを開く
- アドオンを選択(ADDON_IDが自動入力される)
- ADDON_NAME・CHECK_DAYSを確認・設定する
- 「ダウンロード」ボタンをクリック
- ダウンロードしたファイルの
YOUR_API_KEY_HEREをステップ2のキーに置き換える ADDON_MODULEをアドオンのフォルダ名に変更する
ステップ 4:アドオンに組み込む¶
license_client.py をアドオンフォルダに配置し、__init__.py に以下を追加します。
from . import license_client
from . import your_feature_module # 機能モジュール
def register():
license_client.setup(
on_activate = lambda: your_feature_module.register(),
on_deactivate = lambda: your_feature_module.unregister(),
)
def unregister():
license_client.teardown()
try:
your_feature_module.unregister()
except Exception:
pass
ステップ 5:ユーザーへの配布と承認¶
- アドオンをZIPにして配布する
- ユーザーがBlenderのプリファレンス画面からメールアドレスを入力して申請する
- 「ライセンス申請」画面で申請を確認し、「承認」をクリック
- ライセンスキーがユーザーにメールで自動送付される
- ユーザーがキーを入力して認証完了
完了
これでライセンス管理の基本的なセットアップは完了です。