API für Benutzerkontoinformationen
Rufen Sie die aktuellen Kontodaten des Benutzers über ein Zugriffstoken ab.
Prüfen Sie zentrale Informationen wie Tarif, Verifizierungsstatus und Regionseinstellungen und nutzen Sie diese in Ihrer Anwendungslogik.
Diese API ist ab dem Personal-Tarif verfügbar.
/api/user/v1/get
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
- Antwortcode: 0 = Erfolgreich, jeder andere Wert = Fehler
- messagestring
- Antwortnachricht. Wenn der Antwortcode ungleich 0 ist, wird eine Fehlermeldung zurückgegeben.
- resultobject
- eml string
- E-Mail-Adresse des Benutzers.
- nm string
- Benutzername.
- planNm string
- Aktueller Tarifplan.
- planExpires date
-
Ablaufdatum des Tarifs.
Läuft um 00:00 Uhr nach Korea-Standardzeit (UTC +09:00) ab. - locale string
- Sprache und Region des Benutzerkontos.
- timeZone string
-
Zeitzone.
Sprache, Region und Zeitzone können auf der Seite [Einstellungen → Profil] geändert werden. - emlVerifiedYn string
- Default:N
-
Enum:
YN
-
E-Mail-Bestätigungsstatus.
Y: Bestätigt, N: Nicht bestätigt. - twoAuthYn string
- Default:N
-
Enum:
YN
-
Zwei-Faktor-Authentifizierung.
Y: Aktiviert, N: Deaktiviert. - sinYmdt datetime
- Letzter Login-Zeitpunkt.
- regYmdt datetime
- Kontoerstellungszeitpunkt.
Wann diese API verwenden
Verwenden Sie diese API, wenn Sie im Dashboard Ihrer Anwendung Benutzerinformationen wie Name oder Tarif anzeigen möchten.
Sie ist besonders hilfreich, um das Ablaufdatum des Tarifs (planExpires) und den Status der Zwei-Faktor-Authentifizierung (twoAuthYn) zu prüfen, sodass Sie den Zugriff auf Funktionen steuern oder Sicherheitshinweise geben können.
Anwendungsfälle
Die Antwortdaten können in verschiedenen Bereichen Ihrer Anwendungslogik eingesetzt werden.
- Funktionsbeschränkungen basierend auf dem Tarif anwenden
- Zugriff basierend auf dem Authentifizierungsstatus steuern
- UI basierend auf Region oder Sprache anpassen
- Zusätzliche Verifizierung basierend auf 2FA-Einstellungen anfordern
Kurz gesagt dient diese API als zentrale Eingabe zur Steuerung des Anwendungsverhaltens.
Beziehung zur Authentifizierungs-API
Diese API kann nur nach dem Aufruf der Authentifizierungs-API verwendet werden.
Typischer Ablauf:
- Authentifizierungs-API aufrufen → Token erhalten
- Token übergeben → Benutzerinformationen abrufen
Kurz gesagt:
- Authentifizierungs-API → Zugriffsberechtigung erhalten
- Abfrage-API → Benutzerdaten nutzen
Wichtige Punkte im Betrieb
Diese API ist nicht nur eine einfache Abfrage, sondern eine zentrale API, die Service-Richtlinien mit dem Benutzerstatus verknüpft.
- Tarifbasierte Abrechnungslogik
- Durchsetzung von Sicherheitsrichtlinien
- Optimierung der Benutzererfahrung
- Zugriffskontrolle für Funktionen
Sie dient als zentrale Datengrundlage für die gesamte Service-Logik.
Wichtige Hinweise
- Anfragen schlagen fehl, wenn das Token abgelaufen ist.
- Geben Sie keine sensiblen Daten direkt im Client preis.
- Bei Verwendung von Caching werden Änderungen am Benutzerstatus möglicherweise nicht sofort wirksam.
- Berücksichtigen Sie stets die Logik basierend auf dem Verifizierungsstatus (
emlVerifiedYn).