Oura Ringは、睡眠パターンや活動量などの貴重なデータを提供する革新的なウェアラブルデバイスです。個人でOura Ringのデータを利用する場合、APIアクセスのためのパーソナルアクセストークンの取得が必要です。この記事では、Oura APIへのアクセスにパーソナルアクセストークンを使用する方法を詳しく説明します。

ステップ1: Oura開発者ポータルへのアクセス

まずは、Oura開発者ポータルにアクセスします。

Ouraの公式ウェブサイト（ouraring.com）にアクセスし、サイトのフッターまたはメニューで「開発者向け」または「API」のセクションを探し、開発者ポータルへのリンクをクリックします。

公式ウェブサイトのフッターに行くとこんな感じの表記↓

「開発者向け」をクリックすると、下記のような開発者ポータルの画面へ遷移します。

開発者ポータルに辿り着き、「開始」をクリックすると下記のような『Oura API Documentation (2.0)』という英語のドキュメントページが開きます。（基本的にAPIを扱うための最新の情報がこちらに記載されています。）

『Oura API Documentation (2.0)』というドキュメントページで少し下にスクロールすると、「Personal Access Token」というリンクがあるのでそれをクリック。

ステップ2: Ouraアカウントとの連携

新しく開かれたページでは、Personal Access Tokenを取得するために、Ouraアカウントでログインします。実際にOura ringを所持している方は、Oura ringを使い始める際に登録したアカウントになります。

登録したEmailとパスワードを入力してOuraアカウントでログインします。これにより、個人のOuraデータにアクセスするための設定が可能になります。

ステップ3: パーソナルアクセストークンの取得

無事ログインに成功すると、下記のような英語のページが開かれると思います。ログイン後、画面上に表示される「Personal Access Token」セクションを見つけます。（※My ApplicationsでもAPIを叩くのに必要な操作ができますが、今回はPersonal Access Tokenを使っていきます。）

画面右上に表示される「Create a Personal Access Token」をクリックして新しいトークンを生成します。（※注意：アクセストークンはセキュリティ上の理由から、他人と共有しないようにしてください。）

「Create a Personal Access Token」をクリックすると上記のような画面に遷移するので、必要に応じてNoteの欄にメモを記載します。（※Noteの欄は、自分自身が複数トークンを作る予定がある場合、どれが何のためのトークンか分かる自分用のメモ程度の情報でOKです。）

今回は睡眠を記録するアプリを作ろうと思っているので、「Sleep Recording App」というメモを記載しました。Note欄の記載ができたら、「Creat Personal Access Token」ボタンをクリックしてトークンを作成します。

作成ができると上記のような画面になり、作成したトークンとメモ、作成日時が表示されます。
作成したトークンはOura APIにアクセスする際に必要となりますので、安全に保管しておきましょう。（※注意：繰り返しになりますが、アクセストークンはセキュリティ上の理由から、他人と共有しないようにしてください。）

ステップ4: APIへアクセスして確認

最後に、作成したPersonal Access Tokenを使ってAPIにアクセスし、自分自身のOura ringで取ったデータにアクセスできるかを確認してみましょう。

Personal Access Tokenを使ってAPIにアクセスする方法はいくつかありますが、特に事前準備もいらず、簡単に確認できるので今回はパソコンの既存の「コマンドプロンプト」または「ターミナル」を使って確認していきます。

Windowsではスタートメニューから「コマンドプロンプト」を検索して開きます。macOSやLinuxでは「ターミナル」を開きます。

Windowsでは「コマンドプロンプト」、macOSやLinuxでは「ターミナル」で、下記のコマンドを入力し、エンターキーを押すと、APIからのレスポンスが表示されます。

curl -X GET "https://api.ouraring.com/v2/usercollection/sleep?start=2023-11-24&end=2023-11-25" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

この例では、2023年11月24日から11月25日までの睡眠データを取得しています。startとendはURLパラメータで、それぞれ取得したい期間の開始日と終了日を指定します。YOUR_ACCESS_TOKENは、あなたのOura Ringアクセストークンに置き換えてください。

データが羅列していて見づらいですが、APIにアクセスしてほしい日付のデータを取得することができました。

おまけ

上記の例では、Oura ringで取得した『sleep』のデータを取得できているかを確認しました。
それ以外のデータについては、どのデータを取得したいかによって使用するコマンドの中身(エンドポイント)が若干変わってきます。（※僕が専門用語を知らなかっただけですが、「APIのエンドポイント」＝「データを取得するためのURL」だそうです。）

活動データを取得するためのエンドポイント

curl -X GET "https://api.ouraring.com/v2/usercollection/activity?start=YYYY-MM-DD&end=YYYY-MM-DD" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

準備度（readiness）データを取得するためのエンドポイント

curl -X GET "https://api.ouraring.com/v2/usercollection/readiness?start=YYYY-MM-DD&end=YYYY-MM-DD" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

パーソナルデータ(登録した体重、身長、メールアドレスなど)を取得するためのエンドポイント

curl -X GET "https://api.ouraring.com/v2/usercollection/personal_info" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

まとめ

Oura RingのAPIにパーソナルアクセストークンを使用してアクセスする方法は、個人のデータ分析や健康管理に非常に有用です。この記事で紹介した手順を丁寧に実行することで、自身のOuraデータを活用し、より深い洞察を得ることが可能になります。次回は、このデータを活用して行うことができる具体的な分析例や活用方法について解説します。