Oura APIを使用すると、Ouraリングによって生成されたデータに簡単にアクセスすることができます。 Oura APIを使用するには、Ouraアカウントに加えて、パーソナル アクセストークンまたはAPIアプリが必要です。
Oura APIとは
Oura APIの使用方法
パーソナル アクセストークンの作成方法
パーソナル アクセストークンの使用方法
その他の情報
Oura APIとは
Oura APIを使用することにより、Ouraのデータを取得したり、サードパーティサービスとの間でOuraデータを共有できる連携機能を利用することができます。
Oura API V1は2016年にリリースされ、Oura API V2は2022年1月にリリースされました。 V1のサポートは、2023年初めに終了しました。
Oura APIの使用方法
Oura API V2の完全なドキュメントは、 こちらをご覧ください。
第3世代Ouraリングをお使いの方は、有効なOuraメンバーシップをお持ちでない場合、Oura APIを通じてデータにアクセスすることができなくなります。 さらに、有効なOuraメンバーシップをお持ちでない場合、Oura APIと連携したパートナーアプリも、第3世代Ouraリングのデータにアクセスすることができなくなります。 ただし、Ouraをお使いの方は全員、引き続きOura on the Webを通じて手軽にデータをダウンロードすることができます。 これらのデータファイルは、少なくともGDPR要件に準拠しています。
Oura API V2で利用可能な新しいデータタイプをサポートするには、Ouraモバイルアプリの最新バージョンに更新する必要があります。
Oura API V1の既存のアクセストークンは、個人情報、日々のアクティビティ、コンディション、睡眠、就寝時刻のデータを引き続きOura API V2で使用するために有効です。 Oura API V1の既存のアクセストークンは、日中の心拍数、ワークアウト心拍数、ワークアウト、タグ、セッション、および将来リリースされるその他のデータタイプを含む、Oura API V2を通じて利用可能な新しいデータタイプには、アクセスできません。 Oura API V2により提供される新しいデータタイプにアクセスするには、新しいパーソナルアクセストークンを作成するか、OAuth認証フローを介してユーザーに新しいデータスコープへの同意を求める必要があります。
第2世代Ouraリングをお使いの場合、Oura APIを通じたデータの可用性に変更はありません。
パーソナル アクセストークンの作成方法
Ouraでは、Oura Cloud APIとの連携が手軽にできるパーソナル アクセストークンも提供しています。 OuraのCloud APIからプログラムを利用してOuraデータを取得したい場合、パーソナル アクセストークンがあれば手軽に連携できます。現在、グループ アクセストークンは提供されていません。
パーソナル アクセストークンを作成する手順は、以下のとおりです。
- パーソナル アクセストークン ページに移動します
- ページの右上にある[新しいパーソナル アクセストークンの作成]をクリックします
- 作成する新しいパーソナル アクセストークンの一意のメモを入力します
- [パーソナル アクセストークンの作成]をクリックしてフォームを送信し、新しいパーソナル アクセストークンを作成します
[パーソナル アクセストークン]ページに新規アクセストークンが表示されます。
このページから移動するとトークンを表示できなくなるため、必ず新規トークンをコピーしてください。 [コピー]をクリックして、トークンをクリップボードにコピーします。
パーソナル アクセストークンの使用方法
パーソナル アクセストークンを取得後は、トークンを使ってOura APIにアクセスすることができます。 パーソナル アクセストークンを使用するには、次の2つの方法があります。
-
HTTPヘッダー:次のように、認証ヘッダーにパーソナル アクセストークンを追加します。
GET /v1/userinfo HTTP/1.1
Host: api.ouraring.com
Authorization: Bearer PHCW3OVMXQZX5FJUR6ZK4FAA2MK2CWWA -
URLパラメータ:API呼び出しにaccess_token(アクセストークン)パラメータを追加します。
https://api.ouraring.com/v1/userinfo?access_token=PHCW3OVMXQZX5FJUR6ZK4FAA2MK2CWWA
パーソナル アクセストークンはいつでも取り消すことができます。