アプリ開発用API利用方法

1. はじめに

本ドキュメントではFujitsu Research Portalで公開しているアプリ開発用APIの利用方法について説明します。

アプリ開発用APIを利用するためにはアカウント作成の後、作成したアカウントでログインする必要があります。アカウント作成方法については、アカウント作成方法を参照してください。アプリ開発用APIを利用するためには、サブスクリプションキーをOcp-Apim-Subscription-Keyヘッダに付与する必要があります。サブスクリプションキーの発行方法については、サブスクリプションキー発行方法を参照してください。

通常のAPIとアプリ開発用APIの2種類が用意されている場合、次のような違いがあります。通常のAPIは、APIアクセストークンによりAPIを利用可能ですが、APIアクセストークンには有効期限があるため、APIを試用する用途に適しています。ユーザ固有のパラメータはAPIアクセストークンから読み出されます。一方、アプリ開発用APIは、固定のサブスクリプションキーによりAPIを利用可能なため、APIを利用してアプリを開発する用途に適しています。ユーザ固有のパラメータは、アプリ側で制御してAPIへのリクエストパラメータに含める必要があります。

2. 利用方法

本ドキュメントではFujitsu Research Portalで公開しているアプリ開発用APIの利用方法を2種類説明します。

• 2.1. Fujitsu Research Portal上でのアプリ開発用APIの利用
• 2.2. cURLからのアプリ開発用API利用方法
  • Postmanなどでも同様に利用可能なので適宜読み替えてください。

2.1. Fujitsu Research Portal上でのアプリ開発用APIの利用

1. Fujitsu Research Portalへのログイン後、利用したい技術を選択し、「技術のお試しはこちら」から「詳細」ページに移ります。

2. 「詳細」ページ下部の「技術を試す」ボタンをクリックします。「技術を試す」ボタンは、未ログインの場合、またはログイン済みであるが技術個別規約に同意していない場合に表示されます。
   

3. ポップアップに、SMSに届いた「確認コード」をフォームに入力し「コードの確認」ボタンをクリックします。
   

4. 「利用規約への同意について」の内容を確認し、同意いただける場合は「利用規約に同意する」のチェックボックスにチェックを入れて「次に進む」ボタンをクリックします。同意いただけない場合は、上部の「キャンセル」をクリックして画面を閉じてください。
   

5. 「詳細」ページに「アプリ開発用APIを試す」ボタンが表示されるようになりますので、クリックして「アプリ開発用API仕様」ページに移ります。
   

6. API一覧から「[FRP]サブスクリプション情報取得」-> 「Try It」をクリックしてAPI操作ページを表示し、Subscription keyのプルダウンからAPIリクエストに使用するサブスクリプションキーを選択して、「Send」ボタンをクリックします。
   

7. レスポンスのidフィールドに記載されたサブスクリプションIDをメモします。

8. 左部のAPIのリストより利用したいAPIを選択します。 利用したいAPIのヘッダやパラメータ、ボディを確認し、右上の「Try it」ボタンをクリックし「Try it」ページを表示します。
   

9. 「Try it」ページの「Authorization」タブを開き、「Subscription key」の項目で「Primary: [サブスクリプション名]」を選択します（Secondaryも利用可能です）。選択すると、「Headers」タブに自動で「Ocp-Apim-Subscription-Key」項目にサブスクリプションキーが入力されます。
   

10. 「Parameters」や「Headers」、「Body」の各項目に必要な情報を入力し、「Try it」ページの下部の「HTTP request」タブの「Send」ボタンをクリックします。「HTTP request」タブ下のプルダウンメニューから言語を選択することでその言語でのAPIリクエストを行うためのコードが表示されます。各アプリに設定するパラメータには9でメモしたサブスクリプションIDを利用します（使用方法は各アプリケーションのマニュアルやAPI仕様書を参照してください）。
    

11. 実行結果が表示されることを確認してください。
    

2.2. cURLからのアプリ開発用API利用方法

1. Fujitsu Research Portal上でのAPIの利用の手順1-3と同様に「アプリ開発用API仕様」ページに遷移し、利用したいAPIを選択し、内容を確認してください。

2. Fujitsu Research Portal上でのAPIの利用の手順9-11と同様の操作をし、「Try it」ページに必要な項目を埋めます。

3. 「HTTP request」タブ下のプルダウンメニューから「Curl」を選択し、「Copy」をクリックしてcURLコマンドをコピーします。「Reveal secrets」をクリックすることでAPIアクセストークンを表示し、画面上からもコピーできます。
   

4. cURLが利用できる環境のターミナルなどを起動し、コピーしたコマンドをペーストして実行します。
   

5. 実行結果が表示されるので確認してください。
   

2.3. API仕様書のダウンロード

「アプリ開発用API仕様」ページ中央の「API definition」から形式を選択することで、指定の形式のAPI仕様書をダウンロードできます。