OAuth2 / OpenID Connect

OAuth2 / OpenID Connect クライアント登録 #

このドキュメントでは、Nature の OAuth2、OpenID Connect プロバイダーへのクライアント登録に必要な情報について説明します。

OAuth2、OpenID Connect クライアント登録は法人ユーザーのみに限定されています。クライアント登録のご希望の際は Nature ビジネスページ からお問い合わせください。

クライアント設定 #

Nature は OpenID Connect 設定を以下のエンドポイントで提供しています:

https://api.nature.global/.well-known/openid-configuration

このエンドポイントは、 OpenID Connect Discovery 1.0 仕様(OpenID Foundation)に基づいています。

必要なクライアント情報 #

OAuth2、OpenID Connect クライアントを登録するには、以下の情報を提供してください:

アプリケーション詳細 #

  • アプリケーション名: アプリケーションの名前
  • アプリケーション説明(英語): ユーザーに表示される英語での簡単な説明
  • アプリケーション説明(日本語): ユーザーに表示される日本語での簡単な説明

これらの説明は home.nature.global に表示され、ユーザーは許可したアプリケーションのスコープの確認と取り消しができます。

技術設定 #

  • リダイレクト URI: アプリケーションで許可されるリダイレクト URI の完全なリスト
    • 有効な HTTPS URL である必要があります(開発中の localhost を除く)
    • アプリケーションが認可コードを受け取ることを期待するすべての URL を含める必要があります。
  • スコープ: アプリケーションが必要とする OAuth2 スコープを選択

利用可能なスコープ #

スコープ 説明(日本語) 説明(英語)
openid Nature ユーザー ID(E-Mail を含まない)の取得 Get Nature user ID (not including E-mail)
basic プロフィール(E-Mail を含まない)、Nature Remo、家電の取得および編集。センサーデータの取得。 Read and write your profile (not including E-mail) and home appliances
basic.read プロフィール(E-Mail を含まない)、Nature Remo、家電、信号の取得。センサーデータの取得。 Read only access to your profile (not including E-mail), Nature Remo, home appliances and signals
home 家の情報の取得および編集 Read and write user’s home information
home.read 家の情報の取得 Read only access to user’s home information
detectappliance 赤外線信号からエアコンのモデルを認識 Detect air conditioner model from infrared signals
sendir リモコン信号の送信と家電の操作 Send IR signals and control home appliances
sendrawir 任意の赤外線信号を家電に送信して操作 Send raw IR signals directly to your home appliances
elapi ECHONET Lite API の使用 Use ECHONET Lite API
echonetlite ECHONET Lite を使用して家電の状態の取得と操作 Use ECHONET Lite to monitor and control home appliances

注意: .で区切られたスコープは階層を表します。例:basicbasic.readを含みます。

ユーザー同意インターフェース #

アプリケーションの説明は home.nature.global でユーザーに表示され、以下のことができます:

  • アカウントにアクセスできるアプリケーション、説明およびスコープの確認
  • アクセストークンの取り消し

home.nature.globalでの同意画面の例:

同意画面のスクリーンショット

アクセストークンリストの例:

アクセストークンリスト

Copyright © 2017- Nature Inc.