メインコンテンツまでスキップ

認証

RIKYU Public API はすべてのリクエストで Bearer トークン認証 を必要とします。

API キーの使い方

発行した API キーを Authorization ヘッダーに設定します。

Authorization: Bearer <api_key>

Bearer プレフィックスを含めてください(スペースを忘れずに)。

リクエスト例

curl -X GET https://api.rikyu.jp/v1/wallets \
-H "Authorization: Bearer rkyu_live_xxxxxxxxxx"

API キーの権限

API キーには以下の権限を設定できます。

権限説明
readデータの参照(GET 系エンドポイント)
writeデータの更新(PATCH / PUT / POST 系エンドポイント)

権限の組み合わせはキー作成時に設定します。read のみのキーは参照専用として安全に運用できます。

セキュリティ上の注意

  • API キーはソースコードや公開リポジトリに含めないでください
  • キーが漏洩した場合はすぐに RIKYU の API 設定画面から無効化し、新しいキーを発行してください
  • 環境変数や Secret Manager を使って管理することを推奨します

認証エラー

認証に失敗した場合は 401 Unauthorized を返します。

{
"type": "https://errors.rikyu.jp/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Invalid or missing API key"
}