RESTful API でクラウドにアクセスする際には、アクセス トークンを取得する必要があります。また、アクセス トークンを取得するためには、あらかじめデベロッパ ポータルにサインインして、Client ID と Client Secret(別名:Consumer Key と Consumer Secret)を取得しておく必要があります。
Autodesk Forge Platform API で使用出来る API も増加して、デベロッパ ポータルのデザインも変更されていますので、改めて、アプリの登録とキーの取得についてまとめておきたいと思います。
さて、一般的なクラウド サービスでは、クラウドにアクセスするために「ログイン」または「サインイン」と呼ばれるアカウント認証が必要なのはご存じのとおりです。API を使ってクラウドにアクセスする場合にも、もちろん、アカウント認証に代わる処理が必要となります。ただ、ここで扱うことになるのは、ユーザ名やパスワードではありません。開発者に割り当てられた Client ID と Client Secret を利用して、OAuth2 仕様に基づいたアクセス許可を得ることで、オートデスクが管理するストレージにアクセスします。
- ここで記載しているのは、2021年10月20日現在(改定) のものです。今後、画面構成が変わる可能性があります。ご注意ください。
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 プライバシー ステートメントに同意します。」にチェックする必要があります。リンクから内容をご確認の上、同意可能な場合にはチェック ボックスにチェックを入れてください。
- 次の画面が表示された場合には、入力したメールボックスにメール アドレス確認用のメールが届いています。メールボックス(受信トレイ)を確認してみてください。
- メールボックスに確認メールが届いていたら、[電子メールを確認] をクリックしてください。
- アカウントの作成が完了すると次のページが表示されるので、[完了] をクリックしてください。
- My Apps 画面に移動します。もし、My Apps 画面が表示されない場合には、右上のアカウント名下のメニューから [My Apps] をクリックしてください。
- My Apps 画面に移動したら、アプリを登録するために [CREATE APP] をクリックします。
- アプリの情報を入力します。上から、アプリ名(App Name)、アプリの説明(App description)、コールバック URL(Callback URL)、自身の持つ Web サイトの URL(Your Web Site URL)を入力して、[CREATE APP] をクリックしてください。なお、コールバック URL は、3-legged OAuthで利用する URL を指しますが、A360 や BIM 360 Docs、Fusion Team のユーザ ストレージにアクセスしない限り不要です。ここではダミー入力で結構です。
- ページ下部で、登録するアプリで使用する API を選択したら、 [Create App] をクリックしてアプリが登録します。なお、API の選択は、アプリ登録後にも変更することが出来ます。
- [Create App] をクリックしてアプリが登録されると、画面上にアプリの情報とともに、Client ID と Client Secret が表示されるはずです。Client Secret は既定値で非表示になっていますが、目アイコンをクリックすることで画面に表示されます。もう一度、目アイコンをクリックすると非表示になります。
これで、アプリの登録と、そのアプリ用に割り当てられた Client ID と Client Secret の取得が完了です。 この Client ID と Client Secret は、ユーザ名とパスワードに相当するもので、アプリを開発する開発者を特定するものとなります。もちろん、通常公開すべきものではありませんので、開発者は外部に漏れないよう注意してください。
画面下部の [EDIT >] をクリックすれば、いつでもアプリ内容を変更することが可能です。なお、 Client Secret は [REGENERATE] で再生成することが出来ます。登録したアプリは、アプリ自体を削除したり、登録アプリの内容を変更することも可能です。
-Toshiaki Isezaki
コメント