API d’informations du compte utilisateur

Récupérez les informations du compte utilisateur actuel à l’aide d’un jeton d’accès.

Consultez des données clés telles que le plan d’abonnement, le statut de vérification et les paramètres régionaux afin d’alimenter votre logique applicative.

Cette API est disponible à partir de l’offre Personal.

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
Code de réponse : 0 = Succès, toute autre valeur = Erreur
messagestring
Message de réponse. Si le code n’est pas 0, un message d’erreur correspondant est renvoyé.
resultobject
eml string
Adresse e-mail de l’utilisateur.
nm string
Nom de l’utilisateur.
planNm string
Forfait actuellement utilisé.
planExpires date
Date d’expiration du forfait. Expire à 00 h 00 selon l’heure normale de la Corée (UTC +09:00).
locale string
Langue et région du compte utilisateur.
timeZone string
Fuseau horaire.
La langue, la région et le fuseau horaire peuvent être modifiés sur la page [Paramètres → Profil].
emlVerifiedYn string
Default:N
Enum:
YN
Statut de vérification de l’e-mail.
Y : Vérifié, N : Non vérifié.
twoAuthYn string
Default:N
Enum:
YN
Authentification à deux facteurs.
Y : Activée, N : Désactivée.
sinYmdt datetime
Date et heure de la dernière connexion.
regYmdt datetime
Date et heure de création du compte.

Quand utiliser cette API

Utilisez cette API lorsque vous devez afficher des informations utilisateur, comme le nom ou le niveau d’abonnement, dans le tableau de bord de votre service.

Elle est particulièrement utile pour vérifier la date d’expiration du plan (planExpires) et le statut de l’authentification à deux facteurs (twoAuthYn), afin de contrôler l’accès aux fonctionnalités ou de recommander des mesures de sécurité.

Cas d’utilisation

Les données de réponse peuvent être exploitées dans différentes parties de votre logique applicative.

  • Appliquer des restrictions de fonctionnalités selon le plan
  • Contrôler l’accès selon le statut d’authentification
  • Adapter l’interface selon la région ou la langue
  • Exiger une vérification supplémentaire selon les paramètres 2FA

En résumé, cette API constitue une entrée clé pour piloter le comportement de votre service.

Relation avec l’API d’authentification

Cette API ne peut être utilisée qu’après l’appel de l’API d’authentification.

Flux typique:

  1. Appeler l’API d’authentification → obtenir un jeton
  2. Inclure le jeton → récupérer les informations utilisateur

En résumé:

  • API d’authentification → obtenir les droits d’accès
  • API de consultation → exploiter les données utilisateur

Points clés en production

Cette API ne se limite pas à une simple requête. C’est une API essentielle qui relie les politiques du service à l’état de l’utilisateur.

  • Logique de facturation basée sur le plan
  • Application des politiques de sécurité
  • Optimisation de l’expérience utilisateur
  • Contrôle d’accès aux fonctionnalités

Elle sert de source de données centrale pour toute la logique du service.

Points à considérer

  • La requête échouera si le jeton a expiré.
  • N’exposez pas de données sensibles directement côté client.
  • Lors de l’utilisation du cache, les changements d’état utilisateur peuvent ne pas être reflétés immédiatement.
  • Prenez toujours en compte la logique basée sur le statut de vérification (emlVerifiedYn).