APIリファレンス

APIの試し方

本APIリファレンスには、試用機能（［Try it out］ボタン）が実装されています。画面上で簡単にリクエストを実行し、実際のレスポンスを確認することができます。

ここではManagement API ユーザ管理[/me:get]でマイユーザ情報を取得する場合を例に、試用機能の使い方を以下の3ステップで説明します。

ステップ1：認可コードの取得

まずはアクセストークンの取得に必要な認可コードを取得します。

1 「OAuth2 API」ページにアクセスし、［Authorize］ボタンを押します。

　※OAuth2 API[/authorize:get]の試用機能では、認可コードを取得することができません。

図：OAuth2 APIページ画面

2 Available authorizations画面で認可コードの取得に必要な情報を設定し、［Authorize］ボタンを押します。

設定内容の詳細については、OAuth2 API[/authorize:get]を参照してください。以降は、下記の項目を設定した場合を例に説明します。

  • client_id：アプリケーション開発申請時に発行されたクライアントIDを入力
  • redirect_uri：アプリケーション開発申請時に申請した認可時リダイレクトURI(authorize)を指定
    ※ここでは、例として「https://localhost:8080/」を指定しています。
  • scope：「management」、「archive」、「device」すべての権限を設定

　※「code_challenge_method」を設定する場合は、「plain」／「S256」のどちらか一方にチェックを付けます。両方とも設定すると、エラーになります。

図：OAuth2 API：Available authorizations画面

IoTアクセス制御エンジンのログイン画面が表示されます。

3 IoTアクセス制御エンジンにログインします。

  • 初めてログインする場合

    ［登録はこちら］を押し、表示されたアカウント登録画面で［Googleアカウントで登録］、［dアカウントで登録］、［Facebookアカウントで登録］、［LINEアカウントで登録］のいずれかを押すとアカウントが作成されます。

    図：ログイン画面

    ログイン画面に戻り、「登録済みのアカウントでログインする場合」の操作を行ってください。

  • 登録済みのアカウントでログインする場合

    ［Googleアカウントでログイン］、［dアカウントでログイン］、［Facebookアカウントでログイン］、［LINEアカウントでログイン］のいずれかを押します。各アカウントのログイン画面が表示されたときは、画面の指示に従ってください。

    図：ログイン画面

IoTアクセス制御エンジンへのログインが完了すると、指定したサイトのURLへリダイレクトされます。リダイレクトされたサイトのURLから、認可コード（"code"）を取得します。取得した認可コードは、メモ帳などのテキストエディタにコピー＆ペーストしておくと便利です。

https://localhost:8080/?code=XXXX#

XXXX：リダイレクト時に付与された認可コードです。最後尾の'#'（ターミネータ）は除外してください。

図：リダイレクトサイト画面

　※上記のような画面が表示される場合でも、認可コードは発行されます。

ステップ2：アクセストークンの取得

取得した認可コードを使用してアクセストークンを取得します。

1 「OAuth2 API」ページで、［【POST】/token アクセストークン取得リクエスト］を押します。

選択したAPIおよび、パラメーター（PARAMETERSエリア）、レスポンス（Responsesエリア）の説明が表示されます。

2 ［Try it out］ボタンを押します。

図：OAuth2 API「/token:post」：表示画面

3 各パラメーターの説明に従って、以下の項目を設定します。

  • grant_type："authorization_code"を入力
  • code：ステップ1で取得した認可コードを入力　最後尾の'#'（ターミネータ）は除外してください。
  • redirect_uri：ステップ1で指定したリダイレクト先サイトのURLを入力

　※「* required」の項目は、入力必須です。

4 ［Execute］ボタンを押します。

図：OAuth2 API「/token:post」：Try it out画面
  • cURL：実行されたコマンド
  • Request URL：リクエストの送信先URL
  • Server response：コマンドの実行結果

Server responseからアクセストークン（"accsess_token"）を取得します。取得したアクセストークンは、メモ帳などのテキストエディタにコピー＆ペーストしておくと便利です。

図：OAuth2 API「/token:post」：実行結果画面

ステップ3：APIの実行

取得したアクセストークンを使用して、マイユーザ情報を取得します。

1 「Management API ユーザ管理」ページで、［【GET】/me マイユーザ情報の取得］を押します。

2 ［Try it out］ボタンを押します。

図：Management API ユーザ管理「/me:get」：表示画面

3 「Authorization」に、「Bearer」＋「半角スペース」＋「ステップ2で取得したアクセストークン」を入力します。

4 ［Execute］ボタンを押します。

図：Management API ユーザ管理「/me:get」：Try it out画面

Server responseからマイユーザ情報（"userId", "userName"）を取得できます。

図：Management API ユーザ管理「/me:get」：実行結果画面
ドキュメント