View and Data API アプリ登録とキーの入手

View and Data API はクラウドを利用する Web サービス API です。各種 CAD データをクラウド上にアップロードすることで、どんなデバイスでも Web ブラウザで 2D 図面や 3D モデルを表示したり、データ内の検索が出来るように、ファイルを中間形式に変換する処理が必要です。

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

オートデスクのクラウド サービスで利用するストレージについては、過去のブログ記事 A360 API とストレージの考え方 で概要をご紹介しています。

つまり、View and Data API を使うには、 Consumer Secret と Consumer Key を事前に取得しておく必要があります。ここでは、これらキーの取得方法をご案内します。

Consumer Secret と Consumer Key の入手手順

1. Consumer Secret と Consumer Key を取得するには、はじめにオートデスク デベロッパ ポータル（https://developer.autodesk.com）にアクセスします。
2. デベロッパ ポータルにアクセスすると、画面の右上に [Sign Up] と [Sign In] の 2 つのリンクボタンが表示されます。既に Autodesk ID をお持ちであれば、[Sign In] をクリックしてサインインしてください。このとき、デベロッパ ポータルへはじめてサインインする場合は、下記の 4. へ、一度サインインしたことがある場合には、6. へ進んでください。
   
3. もし、Autodesk ID をお持ちでなければ、[Sign Up] をクリックして Autodesk ID を作成してください。Autodesk ID は、無償で作成することが出来ます。必要な情報を入力して、[サイン アップ] をクリックするだけです。
4. デベロッパ ポータルに初めてサインインをおこなうと、アカウントを作成した本人かどうか確認する処理が実施されます。次のページが表示されます。Autodesk ID 作成時に登録した電子メールアドレスのメールボックスを確認してください。
   
5. メールボックスに「Autodesk アカウントを確認」 というタイトルのメールが届いているはずです。メールを開いて、[電子メールを確認] リンクをクリックして本人確認を終了します。
    
6. サインインが完了すると、右上に Autodesk ID のアカウント名が表示されます。続いて、[Create an App] をクリックして、アプリを登録することで Consumer Key  と Consumer Secret を取得していきます。
   
7. 表示されるページ上部の部分で、登録するアプリで使用する API を選択します。このブログの執筆の時点で、AutoCAD I/O API と View and Data API の 2 つを選択することが出来ます。ここでは、View and Data API をクリックして選択します。 
   
8.  ページ下部にアプリの情報を入力します。上から、アプリ名（App Name）、アプリの説明（App description）、コールバック URL（Callback URL）、自身の持つ Web サイトの URL（Your Web Site URL）を入力して、[Create App] をクリックしてください。なお、コールバック URL は、OAuth2 3-legged で利用する URL を指しますが、ここではダミーで結構です。
   
9.  [Create App] をクリックしてアプリが登録されると、画面上にアプリの情報とともに、Consumer Key と Consumer Secret が表示されるはずです。Consumer Secret は既定値で非表示になっていますが、Show をクリックすることで画面に表示されます。逆に Hide をクリックすると非表示になります。
   

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

なお、 Consumer Secret は、いつでも、Regenerate で再生成することが出来ます。ただし、再生成後には、再生成前の Consumer Secret を利用していた既存アプリやサービスは動作しなくなります。注意してください。登録したアプリは、アプリ自体を削除したり、登録アプリの内容を変更することも可能です。 

 ———————– 参考：OAuth とは？ 

さて、Consumer Key と Consumer Secret 、あるいは OAuth や OAuth2 とはいったい何なのか？という方もいらっしゃると思います。簡単な例で説明するなら、次のようなアクセス権限付与の仕組みです。

• この Autodesk Perspective From Japan ブログを含むオートデスクのブログでは、Typedpad（http://www.typepad.com）という企業のブログ システムを利用しています。
• Typedpad ブログでは、ブログオーナーが公開した記事に、読者のコメントを投稿する仕組みが用意されています。ただし、基本的には、コメントの投稿でも Typedpad のアカウントでサインインが求められます。
• 読者がブログ記事にコメントを投稿する際に、いちいち Typedpad のアカウントを作成するのは面倒です。
• そこで、OAuth を使ったアクセス権限付与の仕組みが用意されています。「コメントを投稿」の部分には、Typedpad アカウント以外のアイコンが配置されていて、いずれかの SNS アカウントがあれば、そのアカウントを使って Typedpad  へコメントを投稿することが出来ます。つまり、Typedpad へのアクセス権限を得ることが出来るようになります。
• もし、ここで Facebook アカウントでサインインしてコメントを投稿しようとすると、必ず、同意を求める画面が表示されるはずです。
  
• ここで使われているのが OAuth です。SNS  や Web ショッピングをお使いの方は、一度は似たような画面を目にしたことがあるかも知れません。

View and Data API を始めとして、オートデスクの Web サービス API では、この OAuth を使ってクラウド ストレージにアクセスしています（現在は OAuth2）。OAuth の概要は、こちら を参照してみてください。

もう少し詳しく、OAuth の動作を理解したい場合には、＠IT の記事 が分かり易いと思います。また、こちらの記事 では、OAuth2 については、上記のような利用方法が解説されています。

Web の世界では、異なるアカウント認証の手続きを出来るだけ簡素化することで、ユーザの利便性を高めていると理解することが出来ます。

———————–  

By Toshiaki Isezaki