Hive OTP 인증 시스템은 게임에 OTP 인증을 적용할 수 있도록 OTP 발송과 OTP 검증으로 구성된 API를 제공합니다.
환경별 접근 URL
서버 | URL |
---|---|
Production | https://otp.qpyou.cn |
Sandbox | https://sandbox-otp.qpyou.cn |
인증 방식
Hive OTP 발송 시스템이 제공하는 API를 사용하려면 먼저 인증 토큰(API KEY)을 발급받아야 합니다. 인증 토큰은 앱센터에 게임이 등록되면 자동으로 생성됩니다. 인증 토큰은 JWT(JSON Web Token: https://jwt.io) 명세를 따르며, 만료 시간이 없어 고정적으로 사용할 수 있습니다.
OTP 발송
OTP SMS 발송
Method | POST |
---|---|
URL | /otp/sms |
- Request Header
필드 타입 Content-Type application/json Authorization bearer {API KEY} - Request Body
필드 타입 필수여부 설명 to String O SMS 수신 전화번호 toCountryNo String O SMS 수신 국가코드 from String X SMS 발신 전화번호
값이 없는 경우 서버에서 임의의 8자리 번호를 생성fromCountryNo String X SMS 발신 국가번호
(기본값: 82)appid String O Hive appid
- Response Header
필드 타입 Content-Type application/json - Response Body
필드 타입 설명 otp String OTP 번호 provider String SMS 제공자 expiry String OTP 유효시간
- Request Sample
1234567{"to" : "01012345678","toCountryNo" : "82","from" : "6014480096","fromCountryNo" : "1","appid" : "com.com2us.sample"} - Response Sample
12345{"otp" : "123456","provider" : "YOUR SMS PROVIDER","expiry" : "2022-07-20T15:18:06.885195100+09:00[Asia/Seoul]"}
OTP email 발송
Method | POST |
---|---|
URL | /otp/email |
- Request Header
필드 타입 Content-Type application/json Authorization bearer {API KEY} - Request Body
필드 타입 필수여부 설명 sender String O 발신 이메일 주소 senderName String O 발신 이메일 이름 receiver String O 수신 이메일 주소 subject String O 이메일 제목 appid String O Hive appid
- Response Header
필드 타입 Content-Type application/json - Response Body
필드 타입 설명 otp String OTP 번호 expiry String OTP 유효시간
- Request Sample
1234567{"sender" : "no-reply@sample.com","senderName" : "YOUR SERVICE NAME","receiver" : "abcd@com2us.com","subject" : "[Your service] 인증번호","appid" : "com.com2us.sample"} - Response Sample
1234{"otp" : "123456","expiry" : "2022-07-20T15:19:19.305116+09:00[Asia/Seoul]"}
OTP 검증
Method | POST |
---|---|
URL | /otp/verify |
- Request Header
필드 타입 Content-Type application/json Authorization bearer {API KEY} - Request Body
필드 타입 필수여부 설명 toCountryNo String X 수신 국가번호 (SMS OTP 검증 시 사용) to String X 수신 전화번호 (SMS OTP 검증 시 사용) receiver String X 수신 이메일 주소 (EMAIL OTP 검증 시 사용) otp String O 수신한 OTP appid String O Hive appid
- Response Header
필드 타입 Content-Type application/json - Response Body
필드 타입 설명 result boolean OTP 검증 결과
- Request Sample 1
123456{"toCountryNo" : "82","to" : "01012345678","otp" : "123456","appid" : "com.com2us.sample"} - Request Sample 2
12345{"receiver" : "abcd@com2us.com","otp" : "123456","appid" : "com.com2us.sample"} - Response Sample
123{"result" : true (or false)}