API関数には一部公開されているものがあり、これを利用して、ユーザとライセンスサーバーとのやり取りを可能にしたり、サードパーティ製ツールへ統合することができます。
Pythonスクリプトwebapiclient.pyは、共通のAPIインターフェースをサポートする任意のサーバーへの書き込みAPIリクエストを、便利なクライアント側インターフェースにラップ済みです。
Note
リクエスト送信にはkwargsのみを使用することを強くお勧めします。今後のリリースでargsの位置が変化したり、削除される可能性もあるため、argsではなくkwargsを使用すると信頼性が高まります。 不正確なargsはエラーにつながる可能性が高い一方で、サーバーが認識しなくなったkwargsは無視されるだけです。
webapiclient.pyインターフェースを使用します。
import webapiclient service = webapiclient.Service("http://localhost:1715/api") response = service.cmd_ls("arg1", arg="value")
ローカルsesinetdからサーバー情報を取得する例。
function_name = "cmd_ls" args = ["arg1"] kwargs = {"arg": "value"} body = dict(json=dumps([function_name, args, kwargs])) endpoint_url = "http://localhost:1715/api" headers = dict() headers["Content-Type"] = "application/x-www-form-urlencoded" requests.post(endpoint_url, data=data, headers=header)
webapiclient.pyを使用しても、Pythonを直接使用しても、同じ一般的なHTTPリクエストが作成されます。
POST /api HTTP/1.1 Host: localhost:1715 Connection: keep-alive Content-Type: application/x-www-form-urlencoded Content-Length: 43 json=["cmd_ls", ["args"], {"arg": "value"}]
API サブトピックAPI ¶
Administrative ¶
-
管理者権限を持つユーザのリストからユーザを削除します。
-
管理者権限を持つユーザのリストにユーザを追加します。
-
ライセンスサーバーの管理者情報を所得します。
Licenses ¶
-
サーバー情報をsesinetdから取得します。
Partition System ¶
-
指定したライセンスセットのユーザルールを更新します。
-
既存のライセンスセットをsesinetdから削除します。
-
ライセンスセットの情報を更新したり、指定した情報を使用して新しいライセンスセットを作成します。
-
特定のライセンスセットのライセンスセット情報を取得します。
-
すべてのライセンスの分割情報を取得します。
-
指定したライセンスセットの分割ルールを更新します。
-
ライセンスセットの動的ユーザを取得します。
Server ¶
-
DNSキャッシュをリフレッシュするようsesinetdに伝えます。
-
サーバーにpingを実行して応答するかどうか確認します。
Webhook ¶
-
WebhookのURLを変更します。
-
Webhookでのイベントのサブスクリプションを変更します。
-
Webhookに関する情報を取得します。
-
Webhookを有効または無効にします。