ユーザーアカウント情報取得API
認証トークンを使用して、現在のユーザーアカウント情報を取得します。
プラン、認証ステータス、地域設定などの主要データを確認し、サービスロジックに活用できます。
このAPIはパーソナルプラン以上で利用できます。
GET
/api/user/v1/get
HTTP Header
X-Access-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...No Request Parameters
{
"code": 0,
"message": "",
"result": {
"eml": "your@gmail.com",
"nm": "Tester",
"planNm": "BUSINESS",
"planExpires": "2025-12-31",
"locale": "en_US",
"timeZone": "America/New_York",
"emlVerifiedYn": "Y",
"twoAuthYn": "N",
"sinYmdt": "2025-10-08 03:36:28",
"regYmdt": "2019-08-13 12:13:01"
}
}Response Parameters
- codeinteger
- レスポンスコード: 0 = 成功、それ以外 = エラー
- messagestring
- レスポンスメッセージ。レスポンスコードが0以外の場合、エラー内容のメッセージが返されます。
- resultobject
- eml string
- ユーザーのメールアドレス。
- nm string
- ユーザー名。
- planNm string
- 現在利用中のプラン。
- planExpires date
-
プランの有効期限。
韓国標準時（UTC +09:00）で00:00時点に有効期限が切れます。 - locale string
- アカウントの言語と地域。
- timeZone string
-
タイムゾーン。
言語・地域・タイムゾーンは[設定 → プロフィール]ページで変更できます。 - emlVerifiedYn string
- Default:N
-
Enum:
YN
-
メール認証の状態。
Y: 認証済み, N: 未認証。 - twoAuthYn string
- Default:N
-
Enum:
YN
-
2段階認証の利用状況。
Y: 有効, N: 無効。 - sinYmdt datetime
- 最終ログイン日時。
- regYmdt datetime
- アカウント作成日時。
このAPIを利用する場面
サービス内のダッシュボードで、ユーザー名やプラン情報を表示する際に使用します。
特に、プランの有効期限（planExpires）や二要素認証の有効化状況（twoAuthYn）を確認することで、機能へのアクセス制御やセキュリティ強化の案内に活用できます。
活用例
レスポンスデータは、さまざまなアプリケーションロジックで活用できます。
- プランに応じた機能制限の適用
- 認証状態に基づくアクセス制御
- ユーザーの地域・言語に応じたUIの最適化
- 2FA設定に基づく追加認証の要求
つまり、このAPIはアプリケーションの動作を決定する重要な入力データとして機能します。
認証APIとの関係
このAPIは、認証APIの呼び出し後にのみ利用できます。
一般的なフロー:
- 認証APIを呼び出し → トークンを取得
- トークンを付与 → ユーザー情報を取得
つまり:
- 認証API → アクセス権限を取得
- 取得API → ユーザーデータを活用
運用上の重要ポイント
このAPIは単なるデータ取得ではなく、サービスのポリシーとユーザー状態を結びつける中核APIです。
- プランに基づく課金ロジック
- セキュリティポリシーの適用
- ユーザー体験の最適化
- 機能アクセスの制御
すべてのサービスロジックの基準データとして活用されます。
利用時の注意点
- トークンの有効期限が切れている場合、リクエストは失敗します。
- 機密情報をクライアント側に直接公開しないようにしてください。
- キャッシュを利用する場合、ユーザー状態の変更がすぐに反映されない可能性があります。
- 認証状態（
emlVerifiedYn）に基づく処理を必ず考慮してください。