RISK EYES V2 アクセストークンAPI

API情報

説明: RISK EYES V2 アクセストークンAPI 仕様書

バージョン: 1.0.0

サーバー: https://www.riskeyes.jp

公開日: 2025年7月14日

概要

ユーザー名とパスワードで認証し、アクセストークンとリフレッシュトークンを取得いたします。ご利用にはAPI案件を契約している必要があるため、APIを使用する前にご契約をお願いいたします。

留意点

セキュリティ

HTTPS必須: 本APIは必ずHTTPS経由で呼び出してください
認証情報の保護: username/passwordは安全に保管し、ログに出力しないでください
トークンの適切な管理: 取得したアクセストークンは安全に保存し、第三者に漏洩しないよう注意してください

トークンの有効期限

アクセストークン: 1日間有効
リフレッシュトークン: 30日間有効
有効期限切れの場合は再度ログインが必要です

利用者管理機能認証

利用者管理機能が有効なアカウントでは、end_user_idの指定が必要です
利用者管理機能にパスワードが設定されている場合は、end_user_passwordが必要です

エンドポイント

POST /api/v2/token

概要: アクセストークン・リフレッシュトークン取得

説明: ユーザー名とパスワードでログインし、アクセストークンとリフレッシュトークンを取得いたします

リクエストパラメータ

パラメータ名	型	必須	説明	例
username	string	必須	ユーザー名	"user"
password	string	必須	パスワード	"password123"
end_user_id	string	任意	エンドユーザーID（子クライアント用）	"user001"
end_user_password	string	任意	エンドユーザーパスワード（子クライアント用）	"childpassword123"

リクエスト例

基本ログイン

{ "username": "user", "password": "password123" }

子アカウントログイン

          { "username": "user", "password": "password123", "end_user_id": "user001",
          "end_user_password": "childpassword123" }
        

レスポンス

200 トークン取得成功

説明: トークン取得成功

レスポンススキーマ

フィールド名	型	説明
access	string	アクセストークン（有効期限1日）
refresh	string	リフレッシュトークン（有効期限30日）

レスポンス例

トークン取得成功:

              { "access":
              "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjQwOTk1MjAwLCJpYXQiOjE2NDA5MDg4MDAsImp0aSI6IjEyMzQ1Njc4OTAiLCJ1c2VyX2lkIjoxMjN9...",
              "refresh":
              "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTY0MzUwMDgwMCwiaWF0IjoxNjQwOTA4ODAwLCJqdGkiOiIwOTg3NjU0MzIxIiwidXNlcl9pZCI6MTIzfQ..."
              }
            

400 リクエストエラー

説明: リクエストエラー

レスポンススキーマ

フィールド名	型	説明
error	string	エラーメッセージ

エラー例

バリデーションエラー:

              { "username": ["この項目は必須です。"], "password": ["この項目は必須です。"] }
            

401 認証エラー

説明: 認証エラー

レスポンススキーマ

フィールド名	型	説明
detail	string	エラーメッセージ

エラー例

アカウントが無効:

{ "detail": "No active account found with the given credentials" }

無効なエンドユーザー:

{ "detail": "Invalid end user ID" }

無効なエンドユーザーパスワード:

{ "detail": "Invalid end user password" }

500 サーバーエラー

説明: サーバーエラー

レスポンススキーマ

フィールド名	型	説明
error	string	エラーメッセージ

エラー例

内部サーバーエラー:

{ "error": "内部サーバーエラー" }

POST /api/v2/token/refresh

概要: アクセストークン更新

説明: リフレッシュトークンを使用して新しいアクセストークンを取得します

リクエストパラメータ

パラメータ名	型	必須	説明	例
refresh	string	必須	リフレッシュトークン	"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."

リクエスト例

          { "refresh":
          "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTY0MzUwMDgwMCwiaWF0IjoxNjQwOTA4ODAwLCJqdGkiOiIwOTg3NjU0MzIxIiwidXNlcl9pZCI6MTIzfQ..."
          }
        

レスポンス

200 アクセストークン更新成功

説明: アクセストークン更新成功

レスポンススキーマ

フィールド名	型	説明
access	string	新しいアクセストークン

レスポンス例

アクセストークン更新成功:

              { "access":
              "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjQwOTk1MjAwLCJpYXQiOjE2NDA5MDg4MDAsImp0aSI6IjEyMzQ1Njc4OTAiLCJ1c2VyX2lkIjoxMjN9..."
              }
            

401 無効なリフレッシュトークン

説明: 無効なリフレッシュトークン

レスポンススキーマ

フィールド名	型	説明
detail	string	エラーメッセージ

エラー例

無効なトークン:

{ "detail": "Token is invalid or expired" }

POST /api/v2/token/verify

概要: トークン検証

説明: トークンの有効性を検証します

リクエストパラメータ

パラメータ名	型	必須	説明	例
token	string	必須	検証するトークン（アクセストークンまたはリフレッシュトークン）	"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."

リクエスト例

          { "token":
          "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjQwOTk1MjAwLCJpYXQiOjE2NDA5MDg4MDAsImp0aSI6IjEyMzQ1Njc4OTAiLCJ1c2VyX2lkIjoxMjN9..."
          }
        

レスポンス

200 成功

説明: 有効なトークンの場合は空のJSONを返却します

レスポンス例

トークン有効:

{}

401 無効なトークン

説明: 無効なトークン

レスポンススキーマ

フィールド名	型	説明
detail	string	エラーメッセージ

エラー例

無効なトークン:

{ "detail": "Token is invalid or expired" }

注意事項

認証情報は安全に管理し、ログに出力しないでください
取得したトークンは第三者に漏洩しないよう注意してください
子クライアント機能をご利用の場合は、適切なend_user_idを指定してください
有効期限切れの場合は再度ログインが必要です
RISK EYESの旧APIではこのAPIで出力されたトークンは利用できないのでご注意ください

公開履歴

バージョン	公開日	変更内容
1.0.0	2025年7月14日	初版公開