2021-10-08

API Key Licensing

H18.5 からAPI キーによるライセンシングが追加された。 API キーライセンスは、従来からのログインIDおよびパスワードの代りになり、これによって、License Administrator や sesictrl などのライセンスツールを使った設定作業を介さずにクライアントが見に行くサーバが指定できる。これが有効なのは、

  1. レンダーファーム上のコンピュータなど、GUI環境のないコンピュータに対しサーバの指定を行う場合
  2. ログインライセンスの代りに使用することで、License Administrator 経由によるログイン (つまりログインID とパスワードの使用) をスキップできる
  3. Houdini webServer など、アーティストを全く介さない Houdini 使用時ライセンスのチェックアウトに使用する
ここでは #2 の方法について Windows 10 上で紹介するが、APIキーは自分 (またはその所属組織の) ログインID とパスワード同様の重要度を持つことをあらかじめ理解しておく必要がある。


使用したビルド:

  • 2025-05-21 更新: Houdini 20.5.601 (Windows 11)
  • オリジナル: Houdini 18.5.696 Windows 10 (18.5.672 でも動いた)

1. API キーの取得

API キーの取得には、https://www.sidefx.com/oauth2/applications/ に行く。ここには、https://www.sidefx.com/services/ の Developers API 以下 Manage applications authentication からも行ける。

  1. 初めて来た場合は、API Documentation をさらっと見ておくと良い。
  2. Register a new application ボタンをクリックして API キーの作成に進む。
  3. 次のページで以下の情報を埋めてキーを作成する。太字は必須。
    • Name: 何でも良いが、自分 (使用者) にとって判別し易い名前を付ける。例えば test_myname など。
    • Client id: 自動的に入力されたクライアントのID。そのまま使用。
    • Client secret: 自動的に入力されたクライアントの秘密文字列。そのまま使用。
    • Client type: Confidential または Public のいずれかを選択。上記の#3 などにおいてその使用が公開されない限り、通常は Confidential を選択。
    • Authorization grant type: "Authorization code" または "Client credentials" のいずれかを選択。www.sidefx.com のユーザID への接続が必須でない限り "Authorization code" を選択。ユーザIDに接続する場合は "Client credentials" を選択。
    • Redirect uris: 特に指定すべきものが無い場合は、http://www.sidefx.com で良い。
    • Algorithm 選択はデフォルト (No OIDC Support) のまま。
  4. すべて埋めたら Save をクリックして完了。
      すると API キーが一つ登録される。
  5. これをクリックすれば登録内容が確認できる。
実際に API キーを使うには、このうちの Client id と Client secret の文字列を以下の要領でペーストして使う必要がある。

2. ライセンスの返却

今回は www.sidefx.com をライセンスサーバとして使うので、使用するライセンスを返却する。返却方法はこちらを参照のこと。

3. License Administrator での設定

Houdini 20.5 から API Key を License Administrator 経由で指定できるようになった。以下の方法で行う。

  1. License Administrator を起動、File->Change License Server... に行き、License Server を www.sidefx.com (もしくは使用したいライセンスサーバ) にする。
  2. File->Clear all Cookies and Log Out of Everything を実行して、ログイン状態から抜けるのが良い(と思う)。
  3. File->Login... を実行、開いたパネルの左下にある USE API KEY ボタンをクリック。
    • Client ID に Web ページで得た Client ID
    • Client Secret に Web ページで得た Client Secret 文字列を入力、SAVE ボタンをクリックして閉じる。
エラーが出ず、File メニューの Login のところに (Using API Key) と追加表示されれば成功。

API Key の使用をやめるには、

  1. File->Login ... (Using APIK Key) に行き、 CLEAR ボタンをクリックして文字列を消去。
  2. File->Clear all Cookies and Log Out of Everything を選択。
  3. CONFIRM ボタンをクリックして実行。
これで API Key の設定およびログイン状態がクリアされる。

4. hserver.ini による設定

Windows の場合、H20.5 以降では hserver.ini は C:\ProgramData\SideFX\ にあるものを使う。APIKey 設定のテンプレートは2行目にある。

  1. 2 行目を以下の要領で編集する。
    1. の行頭の # を削除
    2. <client_id> を client_id の実際の文字列に (括弧無)
    3. <client_secret> を client_secret の実際の文字列に (括弧無)
    これらがすべて一行になっているように注意する。
  2. 編集が終わったらファイルを保存。
  3. Services で HoudiniServer を再起動 (一度終了 (Stop) して再度開始 (Start)) する。
設定が正しければ、License Administrator に API Key 経由でログインし要る状態となり、ライセンスも取得できる
    hserver.log を見ると、何がおかしいのかわかるかもしれない。

API キーをやめるには、

  1. hserver.ini の APIKey の行頭に '#' を挿入してコメントアウトし、ファイルを保存。
  2. Services で HoudiniServer を再起動。
これでクリアされた状態となる。

5. トラブルシューティング

動かない場合、以下のことを確認する。

  • License Administrator 経由で設定して動かない場合
    • 各フィールドに余計な文字やスペースが入っていないことを確認
    • License Adminsitrator と hserver のバージョン(およびビルド番号)を確認。同じバージョンであるのが望ましい。
    • hserver.ini に同様の設定がないことを確認
  • hserver.ini 経由で設定して動かない場合
    • hserver.ini の場所を確認。Windows で H20.5 の場合、C:\ProgramData\SideFX\hserver.ini
    • APIKeys 以下の定義が一行で書かれていることを確認
    • License Administrator に同様の設定がないことを確認
  • hserver.log を見ると、何がおかしいのかわかるかもしれない。

従来 Windows では、Houdni の hserver および sesinetd (ライセンスサーバ) は C:\Windows\System32 以下にインストールされた。H19 以降および Launcher を使った場合、

  • hserver は C:\Program Files\Side Effects Software\Houdini Server\ に
  • sesinetd と sesictrld は C:\Program Files\Side Effects Software\License Server\ に
格納されるように変更になった。よって、バージョンに合せて hserver.ini のある場所を確認する必要がある。

使用している hserver の場所を確認するには、Windows のスタートメニューから Servies を起動、HoudiniService を探し、そのプロパティを見る。

繰り返しになるが、APIキーは自分 (またはその所属組織の) ログインID とパスワード同様の重要度を持つことをあらかじめ理解しておく必要がある。

リンク

最終更新: 2025-05-21
投稿者 時刻:
ラベル: ,

0 件のコメント:

コメントを投稿

登録: コメントの投稿 (Atom)