コンテンツにスキップ

API利用方法

1. はじめに

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

Fujitsu Research Portalで公開しているAPIを利用するためには、アカウント作成後、作成したアカウントにログインする必要があります。アカウント作成方法については、アカウント作成方法を参照してください。また、APIアクセストークンをAuthorizationヘッダに付与する必要があります。APIアクセストークンの発行方法については、APIアクセストークン発行方法を参照してください。なお、マニュアルで利用しているスクリーンショットなどは最新のポータル画面と異なる場合がありますのでご了承ください。

通常の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などでも同様に利用可能なので適宜読み替えてください。　　

また、APIアクセストークンを用いて、Fujitsu Research Portal上のAPIを利用する場合、ユーザごとに5 request / min という利用回数の制限があります。ユーザごとにカウントするため、異なるAPIを利用した場合もカウントされます。

2.1. Fujitsu Research Portal上でのAPIの利用

  1. ログイン後、Fujitsu Research Portalのホーム画面中央または右上の「技術一覧」より「技術一覧」ページに移ります。 portal-top-technology-list

  2. 「技術一覧」より利用したい技術を選択し、「ドキュメント」ページに移ります。

  3. 「ドキュメント」ページの「技術のお試しはこちら」から「詳細」ページに移ります。

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

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

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

  7. 「詳細」ページに「APIを試す」ボタンが表示されますので、クリックします。「APIを試す」ボタンは、ログイン済みかつ技術個別規約に同意した場合に表示されます。
    technology-after-tou-latest

  8. API一覧より利用したいAPIを選択します。利用したいAPIのヘッダやパラメータ、ボディを確認し、右上の「Try it」ボタンをクリックして「Try it」ページを表示します。
    api-list-using-the-api

  9. 「Try it」ページの「Authorization」タブを開き、「Developer_Portal_Access_Token」の項目で「authorization_code」を選択します。選択すると、「Headers」タブに自動で「Authorization」項目と認証して得られるAPIアクセストークンが付与されます。
    try-it-using-the-api

    事前に取得したAPIアクセストークンを利用したい場合、「Headers」タブ下部の「＋Add header」をクリック後、「Authorization」項目を追加し、「Bearer eyJ…」を入力します。「eyJ…」とは、事前に取得したAPIアクセストークンです。
    try-it-using-the-api2

  10. 「Parameters」や「Headers」、「Body」の各項目に必要な情報を入力し、「Try it」ページの下部の「HTTP request」タブの「Send」ボタンをクリックします。「HTTP request」タブ下のプルダウンメニューから言語を選択することでその言語でのAPIリクエストを行うためのコードが表示されます。
    try-it-request-using-the-api

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

2.2. cURLなどからのAPI利用方法

  1. Fujitsu Research Portal上でのAPIの利用の手順1-7と同様に「API仕様」ページに遷移し、利用したいAPIを選択し、内容を確認してください。そして、「API仕様」ページの「Request」項目に記載されている「HTTPメソッド」、「URL」、必要があれば、「Request parameters」、「Request headers」、「Request body」をメモします。
    cURL-using-the-api

  2. cURLが利用できる環境のターミナルなどを起動し、cURLコマンドを入力して実行します。この際、必要な「Request headers」に加えて、「Authorization」ヘッダを追加する必要があるため、-H “Authorization: Bearer eyJ…”をコマンドに追加します。「eyJ…」とは、事前に取得したAPIアクセストークンです。　　
    cURL-command-using-the-api

    簡単にcURLコマンド例を取得する方法
    Fujitsu Research Portal上でのAPIの利用の手順8と同様の操作をし、「Try it」ページを表示します。次に、「HTTP request」タブ下のプルダウンメニューから「Curl」を選択し、「Copy」をクリックしてcURLコマンドをコピーします。「Reveal secrets」をクリックすることでAPIアクセストークンを表示し、画面上からもコピーできます。そして、このコマンドを手順2と同様にcURLが利用できるターミナルなどにペーストし実行します。
    cURL-command-try-it-using-the-api

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

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

「API仕様」ページ中央の「API definition」から形式を選択することで、指定の形式のAPI仕様書をダウンロードできます。
api-definition-using-the-api