運営会社
Alteryxツールアイコン「License APIツール」（License API Tool）をご紹介します
License APIツール（License API Tool）
［開発］カテゴリの［License API作成］ツールを紹介します。
概要
このツールはAlteyrxのLicense PortalのAPIを簡単に利用できるマクロです。入手は、Alteryx MARKETPLACE からとなります。
このツールは入力用に２アンカー（いずれもオプションアンカーのため、必ずしも接続する必要はありません）、出力用に４アンカーあり、それぞれ、以下の情報を入出力できます。
認証用データ入力アンカー（A入力）、パラメータデータ用入力アンカー（D入力）については、設定項目のところでご紹介します。
主に使うのは、Success出力（S出力）となります。こちらから欲しい情報を得ることができます。
設定項目
License APIツールの設定は、認証設定とAPI設定の大きく２つに別れています。それぞれ、「フィールドの値を使用」オプションにより、オプション入力に設定した値を使って動的なワークフローにすることも可能です。
認証設定
| 項目 | 内容 |
|---|---|
| ベースURL | デフォルトで入力される値を使用してください |
| 認証URL | デフォルトで入力される値を使用してください |
| リフレッシュトークン | License Portalから入手可能なトークンを入力します |
API設定
| 項目 | 内容 |
|---|---|
| メソッドを選択 | GET/POST/PATCH/DELETEから選択します。
それぞれ、選択したエンドポイントに応じた動きをしますが、おおむねGETは情報の取得、POSTはLicense Portalへの登録、Patchは情報の修正、Deleteは削除に利用します。詳しくはAPIのドキュメントを参照してください。 |
| エンドポイントを選択 | 11個のAPIから選択します。それぞれのエンドポイントに対して機能が割り振られています。例えば、「/v1/devices」でGETをすると、ライセンスがアクティベートされているデバイス情報を受け取ることができます。 |
※APIのドキュメントはこちら 。
なお、多くのエンドポイントで、Account番号（OG-XXXXX）が必要となります。
出力内容
A出力：認証情報出力
ツールに設定している項目がそのまま出力されます。
- AccessToken
- baseURL
- authURL
S出力：Success出力
設定したエンドポイントによって出力内容は異なりますが、本ツールで設定したエンドポイントに応じた出力が得られます。なお、エラーになった際はここには何も出力されず、エラー内容がF出力側に出力されます。
F出力：Failure出力
設定したエンドポイントでエラーが発生した際、エラー内容はこちらに出力されます。
L出力：LOG出力
エンドポイントに対してアクセスした認証データやパラメータなどの設定内容およびエンドポイントから返された結果（生のJSON）などが出力されます。
まとめ
- 新しくなったLicense PortalではAPIが実装されましたが、そのAPIを手軽に操作できるツールです
- 入手はAlteryx MARKETPLACEから行います
- ダウンロードツールをつかわずとも、簡単にDesignerでLicense Portal APIが利用可能になります
※Alteryx Version2023.1.1.281 パッチ: 3 時点での情報です
