Forge API を利用するアプリの登録とキーの取得

Autodesk Forge は 2022年9月開催の Autodesk University で Autodesk Platform Services へ改名されました。

RESTful API でクラウドにアクセスする際には、アクセストークンを取得する必要があります。また、アクセストークンを取得するためには、あらかじめデベロッパポータルにサインインして、Client ID と Client Secret（別名：Consumer Key と Consumer Secret）を取得しておく必要があります。

Autodesk Forge Platform API で使用出来る API も増加して、デベロッパポータルのデザインも変更されていますので、改めて、アプリの登録とキーの取得についてまとめておきたいと思います。

さて、一般的なクラウドサービスでは、クラウドにアクセスするために「ログイン」または「サインイン」と呼ばれるアカウント認証が必要なのはご存じのとおりです。API を使ってクラウドにアクセスする場合にも、もちろん、アカウント認証に代わる処理が必要となります。ただ、ここで扱うことになるのは、ユーザ名やパスワードではありません。開発者に割り当てられた Client ID と Client Secret を利用して、OAuth2 仕様に基づいたアクセス許可を得ることで、オートデスクが管理するストレージにアクセスします。

ここで記載しているのは、2022年9月7日現在(改定) のものです。今後、画面構成が変わる可能性があります。ご注意ください。

Client ID と Client Secret の取得手順

Client ID と Client Secret を取得するには、はじめに Forge ポータル（https://forge.autodesk.com）にアクセスします。
Forge ポータルにアクセスすると、画面の右上に [SIGN IN] ボタンが表示されます。既に Autodesk ID をお持ちであれば、[SIGN IN] をクリックしてサインインしてください。Autodesk ID をお持ちでない場合には、サインアップが必要です。サインアップは、下記の 3. へ、Autodesk ID を持ちの場合には、8. へ進んでください。
Autodesk ID をお持ちでなければ、[アカウントを作成] をクリックして Autodesk ID を作成してください。Autodesk ID は、無償でどなたでも作成することが出来ます。
[アカウントを作成] 画面が表示されます。各項目の入力後、この画面を終了するには、「Autodesk Web Service API サービス使用条件およびAutodesk プライバシーステートメントに同意します。」にチェックする必要があります。リンクから内容をご確認の上、同意可能な場合にはチェックボックスにチェックを入れてください。
次の画面が表示された場合には、入力したメールボックスにメールアドレス確認用のメールが届いています。メールボックス（受信トレイ）を確認してみてください。
メールボックスに確認メールが届いていたら、[電子メールを確認] をクリックしてください。
アカウントの作成が完了すると次のページが表示されるので、[完了] をクリックしてください。
Applications 画面に移動します。もし、Applicationss 画面が表示されない場合には、右上のアカウント名下のメニューから [Applications] をクリックしてください。
Applications 画面に移動したら、アプリケーションを登録するために [Create application] をクリックします。
Create Application 画面が表示されたら、作成するアプリケーション名を入力して、右下の [Create] ボタンをクリックします（半角英数字の利用を推奨）。
入力したアプリケーション名の画面が表示されるので、詳細情報を入力します。General Settings セクション上から、アプリケーション名（Name）、アプリケーションの説明（Description）、コールバック URL（Callback URL）を入力してください。[CREATE APP] をクリックしてください。なお、アプリケーション名には、先に入力した値が既定値として記入されているはずです。また、コールバック URL は、3-legged OAuthで利用する URL を指しますが、ACC や BIM 360 Docs、Fusion Team のユーザストレージにアクセスしない限り不要です。ここではダミー入力で結構です。
API Access セクションで、登録するアプリで使用する API を選択します。使用する API にチェックを入れてください。
ここまでの入力を保存します。右下の [Save Changes] ボタンをクリックしてください

これで、アプリの登録と、そのアプリ用に割り当てられた Client ID と Client Secret の取得が完了です。この Client ID と Client Secret は、ユーザ名とパスワードに相当するもので、アプリを開発する開発者を特定するものとなります。もちろん、通常公開すべきものではありませんので、開発者は外部に漏れないよう注意してください。

開発作業で使用する Client ID と Client Secret は Client Credentials セクションに表示されます。Client Secret は既定値でマスク表示（・・・・・）になっていますが、目アイコンをクリックすることで画面に表示されます。もう一度、目アイコンをクリックすると非表示になります。

Forge ポータルにサインインして、アカウント名下のメニューから [Applications] をクリックすれば、いつでもアプリ内容を変更することが可能です。また、 Client Secret は [Regenerate] ボタンで再生成したり、アプリケーション自体を削除したりすることも出来ます。その場合、同 Client ID を使用して構築されたアプリケーションは動作しなくなりますのでご注意ください。

-Toshiaki Isezaki