로그인
Last updated
Last updated
위핀 RESTful API는 아래와 같이 인증이 필요합니다.
위핀 RESTful API 요청 시, Token을 추가하여 인증을 수행해야 합니다. 위핀 RESTful API의 토큰은 JWT 토큰 포맷으로 생성 됩니다. 기본 JWT 방식의 인증(보안) 강화 방식인 Access Token & Refresh Token 인증 방식을 채택해서 사용합니다.
Access Token은 발급 후 12시간 후 만료됩니다. Refresh Token은 7일 동안 유효하며, 이를 통해 새로운 Access Token을 발급 받을 수 있습니다.
로그인 요청을 보내면 Response에 토큰이 반환됩니다. 여기에는 accessToken
과 refreshToken
토큰이 포함되어 있습니다. 자세한 토큰 발급 절차는 아래와 같습니다.
로그인 과정에서 Access Token과 Refresh Token 을 발급 받습니다.
이후 API Request를 보내기 전에 토큰의 유효성을 검증합니다.
Access Token과 Refresh Token 모두 만료된 경우: 에러 발생. 다시 로그인을 수행해서 새로운 Access Token과 Refresh Token을 발급 받습니다.
Access Token은 만료되었지만 Refresh Token은 유효한 경우: 토큰 재발급 받기를 통해서 Refresh Token을 검증하여 Access Token 을 재발급 받습니다.
Access Token은 유효하지만 Refresh Token은 만료된 경우: 다시 로그인을 수행하여 새로운 Access Token과 Refresh Token을 발급 받습니다.
Access Token과 Refresh Token 모두 유효한 경우: 정상적으로 Request를 보낼 수 있습니다.
위핀 RESTful API를 사용하는 클라이언트 어플리케이션은 토큰의 유효 시간을 확인 후, 토큰이 유효한 경우에만 Request를 수행합니다.
또는 토큰 유효성 검증 없이 API Request를 전송하고, HTTP Status 코드 401
을 받으면 토큰을 재발급 받습니다.
위핀 SDK API의 Request 헤더 값입니다.
Name | Value | Description |
---|---|---|
앱 등록 후 발급 받은 App Key 검증 및 등록한 앱에 대한 정보가 맞는지 확인합니다.
Parameter
Success Response
appInfo
id
: App ID
assets
array of object
coinId
integer
앱에서 사용하는 네트워크 코인 ID
tokens
integer[]
앱에서 사용하는 FT(Fungible Token) ID List
위핀 지갑을 사용하기 위해서 로그인을 해야 합니다. 위핀은 Firebase를 이용한 소셜 로그인 및 이메일 로그인을 지원하고 있습니다. 위핀에서 지원하는 소셜 로그인 목록을 확인하려면 소셜 로그인 인증 프로바이더 페이지를 참고하세요.
위핀은 다양한 개발 환경에 맞게 로그인 라이브러리를 제공하고 있습니다. 플랫폼에 따른 로그인 라이브러리 목록은 API의 개요 페이지를 참고하세요.
Firebase 로그인 결과로 얻은 토큰을 이용하여 위핀 로그인을 수행합니다.
Parameter
token
access
String
Access Token (인코딩 된 JWT 토큰)
refresh
String
Refresh Token (인코딩 된 JWT 토큰)
userInfo
userId
String
사용자 Id
email
String
사용자의 e-mail
name
String
사용자의 이름
locale
String
사용자가 설정해 놓은 언어
currency
String
사용자가 설정해 놓은 통화
lastAccessDevice
String
마지막 접속 기기
lastSessionIp
String
마지막 접속 IP
userJoinStage
Integer
사용자 가입 단계. (REST API를 직접 호출 하는 경우 사용하지 않음)
3
: 가입 완료
profileImage
String
사용자의 프로필 이미지 URL
userState
Integer
사용자 상태
1
: active
2
: deleted
user2FA
Integer
2FA 활성화 여부
0
: 생성은 됐지만 인증이 되지 않은 상태 - 2FA 사용 불가
1
: 등록 완료 상태
2
: 2FA 복구 코드 검증 완료된 상태
Example
사용자 로그아웃을 수행합니다. Firebase 로그아웃과 위핀 로그인 라이브러리의 logout 함수와 함께 사용됩니다.
Parameter
Success Response
비어 있는 Object를 반환 합니다.
발급 받은 Access Token이 만료되고 Refresh Token은 유효한 경우에, 새로운 Access Token을 재발급 받아야 합니다.
Parameter
위핀 지갑 로그인과 동시에 사용자는 지갑 이용 약관에 동의 해야 합니다. 로그인에 성공한 후 이용 약관 동의 여부를 위핀 백엔드 서버에 업데이트 합니다.
Parameter
termsAccepted
termsOfService
Boolean
서비스 이용 약관 동의 여부
privacyPolicy
Boolean
개인정보 처리 방침 동의 여부
위핀 지갑 서비스 약관
Request의 body와 동일합니다.
사용자의 이용 약관 동의 여부를 가져 올 수 있습니다.
Parameter
Code | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description | Required |
---|---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description | Required |
---|---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description | Required |
---|---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description | Required |
---|---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description | Required |
---|---|---|---|