Autodesk Platform Services(APS)の API には、よく似た機能を持つ Token Flex API と Premium Reporting API が存在します。どちらも組織内でのオートデスク製品の使用状況分析とレポートを得るための管理者用 API ですが、対象が異なります。ここでは、両 API の概要と違い、注意点をご案内しておきたいと思います。
対象
オートデスクが提供するサブスクリプション プランには、Standard、Premium、Enterprise の 3 つがあり、 Token Flex API が Enterprise プラン、Premium Reporting API が Premium プランの各契約をお持ちの管理者が対象になります。
Token Flex API
正式名は Token Flex Usage Data API です。Enterprise プラン、俗に Autodesk Enterprise Business Agreement(EBA)と呼ばれる包括契約下で使用される、オートデスク製品の使用状況分析とレポートを得るための API を提供します。
Token Flex API は 2018 年末に登場した API で、このブログでも、Token Flex API について の記事でご案内したことがあります。契約管理者向けに、EBA 契約の製品使用状況分析とレポート用 RESTful API を用意しています。
Premium Reporting API
Premium プランのサブスクリプション契約下で使用される、オートデスク製品の使用状況分析とレポートを得るための API を提供します。
Token Flex API に遅れること約 3 年半、2022 年に正式に導入された API です。同契約の製品使用状況分析とレポート用 RESTful API を用意しています。
違い
両 API とも、従来、Autodesk Account から手動で実行していたワークフローを自動化することが出来ます。ただし、使用するエンドポイントはまったく異なります。
- Token Flex API:REST API Reference | Token Flex Usage Data API
- Premium Reporting API:REST API Reference | Premium Reporting API
同様に、レポートに指定する特定期間や条件の記述方法も異なります。
- Token Flex API:Fields and Metrics | Token Flex Usage Data API
- Premium Reporting API:Fields and Metrics | Premium Reporting API
運用
Token Flex API と Premium Reporting API 共、エンドポイント呼び出しには 3-legged 認証・認可を経て取得したアクセストークンが必要です。この際、認可するアカウントは、プライマリ管理者かセカンダリ管理者である必要があります。(プライマリ管理者かセカンダリ管理者がアプリにサインインして、アプリのリソースへのアクセスを許可し、アクセストークンを得る必要があります。)
Premium Reporting API では、https://profile.autodesk.com/security からパーソナル アクセス トークン(Personal Access Token、PAT )を生成して利用することが出来ます。ただし、この場合も、パーソナル アクセス トークンの生成には、プライマリ管理者かセカンダリ管理者のアカウントで https://profile.autodesk.com/security にサインインする必要があります。
注意点
Token Flex API と Premium Reporting API は、Enterprise 契約、または Premium 契約 をお持ちの管理者用に用意された API です。その性格上、3rd party がアプリを作成しても、検証には管理者アカウントが必須になってしまいます。このため、セキュリティ保護の観点から、3rd party、主に ISV による独自アプリ ビジネスでの利用はお勧めしていません。
Token Flex API と Premium Reporting API 自体には、Microsoft Power BI、あるいはオープンソースの Chart.js のようなグラフ化機能の提供はありません。
By Toshiaki Isezaki
コメント
コメントフィードを購読すればディスカッションを追いかけることができます。