Runtera APIを取得する方法
Runtera APIはAPIキーではなくOAuth 2.0のアクセストークンで利用します。Cloud ConsoleでプロジェクトにRuntera APIを有効化し、データアクセスでスコープを追加したうえで、認可フローで取得したアクセストークンを付けて呼び出します。
Runtera APIを取得する方法
この記事では、Runtera APIを使えるようにするための準備を説明します。Runtera APIは、APIキーではなく、SHOHSのOAuth 2.0で発行されるアクセストークンを使って呼び出すAPIです。そのため、利用にはOAuth認証情報(Client ID / Client Secret)と、プロジェクトでの有効化とスコープ設定が必要です。
前提条件
- SHOHSアカウントを持っていること
- OAuth認証情報を取得していること(未取得の場合は、関連記事「SHOHS Cloud ConsoleでOAuth2.0認証用のIDを取得する方法」を先に行ってください)
手順
- SHOHS Cloud Consoleでプロジェクトを開きます。
- 「ライブラリ」からRuntera APIを有効化します。
- 「OAuth 同意画面」の「データアクセス」で、使うRuntera APIのスコープを追加します(プロジェクト内の全クライアントに反映されます)。
- 自分のアプリから認可リクエストを送り、ユーザーの同意を得てアクセストークンを取得します。
- 取得したアクセストークンを Authorization ヘッダーに付けて、Runtera API(https://runtera.apis.shohs.net/v1)を呼び出します。
主なスコープ
- runtera.read:読み取り権限をまとめて許可
- runtera.write:書き込み権限をまとめて許可(読み取りは含まれません)
- runtera.profile.read:氏名・ユーザー名・役割・自己ベストなどのプロフィール情報の読み取り
実際に使える権限は、「利用者が同意画面で許可したスコープ」と「Cloud Consoleでクライアントに許可されているスコープ」の両方に含まれるものだけです。APIが操作できるのは、常にトークンの持ち主本人のデータだけです。
よくある質問
APIキーは発行されますか?
Runtera APIではAPIキーは発行されません。SHOHS AI APIとは認証方式が異なり、OAuth 2.0のアクセストークンで認証します。
詳しいエンドポイント仕様を知りたい
エンドポイントの一覧やリクエスト例は、SHOHS OAuth 2.0 開発者ドキュメントの「Runtera API」の章をご覧ください。