회원가입 및 연동

Overview#

Android SDK의 회원 가입 및 연동 방법을 안내합니다.

기능 설명#

회원정보를 이용하여 GCCS에 가입 및 연동 기능을 제공합니다.

가입 정보 중복 체크 (유저키)#

GCCS 가입을 진행하기 전 중복되는 유저키가 존재하는지 확인합니다. GuardianSdk 의 hasDuplicateUserKey() 로 API를 요청합니다.

Parameter#

Name	Value	Description
userKey	String	중복 체크 할 유저키

Example#

// 가입 정보 중복 체크GuardianSdk.getInstance().hasDuplicateUserKey("gccsuser", new GuardianResponseCallback<ResultResponse>() {    @Override    public void onSuccess(ResultResponse result) {        Log.i(TAG, "결과코드 : " + result.rtCode);    }
    @Override    public void onFailed(ErrorResult errorResult) {        Log.e(TAG, "에러코드 : " + errorResult.getErrorCode());    }});

ResultResponse#

Key	Value	Description
rtCode	0	결과코드
rtMsg	String	결과 메시지

가입 정보 중복을 체크하는 API를 호출하여 중복되는 정보가 없을 경우에는 rtCode로 0이 수신되며,
중복되는 정보가 있을 경우에는 rtCode로 2009가 수신됩니다.

ErrorResult#

Key	Value	Description
errorCode	0	에러코드

가입 정보 중복을 체크하는 API 호출 실패 시 errorCode 가 수신됩니다.

가입 정보 중복 체크 (이메일)#

GCCS 가입을 진행하기 전 중복되는 이메일 정보가 존재하는지 확인합니다. GuardianSdk 의 hasDuplicateEmail() 로 API를 요청합니다.

Parameter#

Name	Value	Description
userKey	String	중복 체크 할 이메일

Example#

// 가입 정보 중복 체크GuardianSdk.getInstance().hasDuplicateEmail("fnsvalue@fnsvalue.co.kr", new GuardianResponseCallback<ResultResponse>() {    @Override    public void onSuccess(ResultResponse result) {        Log.i(TAG, "결과코드 : " + result.rtCode);    }
    @Override    public void onFailed(ErrorResult errorResult) {        Log.e(TAG, "에러코드 : " + errorResult.getErrorCode());    }});

ResultResponse#

Key	Value	Description
rtCode	0	결과코드
rtMsg	String	결과 메시지

가입 정보 중복을 체크하는 API를 호출하여 중복되는 정보가 없을 경우에는 rtCode로 0이 수신되며,
중복되는 정보가 있을 경우에는 rtCode로 2019가 수신됩니다.

ErrorResult#

Key	Value	Description
errorCode	0	에러코드

가입 정보 중복을 체크하는 API 호출 실패 시 errorCode 가 수신됩니다.

가입 정보 중복 체크 (핸드폰번호)#

GCCS 가입을 진행하기 전 중복되는 이메일 정보가 존재하는지 확인합니다. GuardianSdk 의 hasDuplicatePhoneNumber() 로 API를 요청합니다.

Parameter#

Name	Value	Description
userKey	String	중복 체크 할 핸드폰번호

Example#

// 가입 정보 중복 체크GuardianSdk.getInstance().hasDuplicatePhoneNumber("821012341234", new GuardianResponseCallback<ResultResponse>() {    @Override    public void onSuccess(ResultResponse result) {        Log.i(TAG, "결과코드 : " + result.rtCode);    }
    @Override    public void onFailed(ErrorResult errorResult) {        Log.e(TAG, "에러코드 : " + errorResult.getErrorCode());    }});

ResultResponse#

Key	Value	Description
rtCode	0	결과코드
rtMsg	String	결과 메시지

ErrorResult#

Key	Value	Description
errorCode	0	에러코드

가입 정보 중복을 체크하는 API 호출 실패 시 errorCode 가 수신됩니다.

이메일 인증 요청#

GCCS 가입을 위해서 이메일 인증이 필요합니다. 이메일 인증 요청을 위해 GuardianSdk 의 requestOtpEmail() 로 API를 요청합니다. 이메일 요청이 성공한 경우 입력한 이메일로 가입 인증 코드가 전달 됩니다.

Parameter#

Name	Value	Description
email	String	인증 받을 이메일 주소

Example#

// 가입 정보 중복 체크GuardianSdk.getInstance().requestOtpEmail("fnsvalue@fnsvalue.co.kr", new GuardianResponseCallback<RequestOtpEmailResponse>() {    @Override    public void onSuccess(RequestOtpEmailResponse result) {        Log.i(TAG, "결과코드 : " + result.rtCode);    }
    @Override    public void onFailed(ErrorResult errorResult) {        Log.e(TAG, "에러코드 : " + errorResult.getErrorCode());    }});

DuplicateResponse#

Key	Value	Description
rtCode	0	결과코드
seq	0	가입 인증 seq
rtMsg	String	결과 메시지

ErrorResult#

Key	Value	Description
errorCode	0	에러코드

가입 정보 중복을 체크하는 API 호출 실패 시 errorCode 가 수신됩니다.

이메일 인증 확인#

requestOtpEmail() 에 결과 값인 seq, 이메일에 보여진 가입 인증 코드, 이메일을 입력하여 이메일 인증을 확인합니다. 이메일 인증 확인을 위해 GuardianSdk 의 verityOtpEmail() 로 API를 요청합니다. 정상적인 가입 인증 코드 인 경우 가입에 사용하는 token 값이 전달 됩니다.

Parameter#

Name	Value	Description
email	String	인증 받을 이메일 주소
seq	Int	인증 요청 seq
authNum	String	인증 코드

Example#

// 가입 정보 중복 체크GuardianSdk.getInstance().verityOtpEmail("fnsvalue@fnsvalue.co.kr", 23, "452422", new GuardianResponseCallback<VerityOtpResponse>() {    @Override    public void onSuccess(VerityOtpResponse result) {        Log.i(TAG, "결과코드 : " + result.rtCode);        Log.i(TAG, "가입토큰 : " + result.token);    }
    @Override    public void onFailed(ErrorResult errorResult) {        Log.e(TAG, "에러코드 : " + errorResult.getErrorCode());    }});

VerityOtpResponse#

Key	Value	Description
rtCode	0	결과코드
result	Boolean	인증 코드 맞는지 여부
token	String	가입 인증 토큰

이메일 인증 확인하는 API를 호출하여 정상적인 인증 코드가 맞는 경우 rtCode로 0과 result 값이 true 가 수신 됩니다.

ErrorResult#

Key	Value	Description
errorCode	0	에러코드

가입 정보 중복을 체크하는 API 호출 실패 시 errorCode 가 수신됩니다.

GCCS 가입#

GCCS 가입을 진행하기 위해 GuardianSdk 의 registerUser() 로 API를 요청합니다.
기본적인 정보 이외에 이메일 인증 확인 API 로 받은 token 이 필요합니다.

Parameter#

Name	Value	Description
userKey	String	유저 아이디
name	String	이름
phoneNum	String	핸드폰번호
email	String	이메일
disposeToken	String	이메일 인증 후 토큰

Example#

// GCCS 가입GuardianSdk.getInstance().registerUser("gccsuser","gccsname", "fnsvalue@fnsvalue.co.kr", "821014231234", "{token}" new GuardianResponseCallback<RegisterUserResponse>() {    @Override    public void onSuccess(RegisterUserResponse result) {        ...    }
    @Override    public void onFailed(ErrorResult errorResult) {        ...    }});

RegisterUserResponse#

Key	Value	Description
rtCode	0	결과코드
rtMsg	String	결과 메시지

GCCS 가입 API 호출 성공 시 rtCode로 0이 수신되며, 회원가입이 완료됩니다.

ErrorResult#

Key	Value	Description
errorCode	0	에러코드

GCCS 가입 API 호출 실패 시 errorCode 가 수신됩니다.

회원 비활성화#

GCCS 회원 비활성화를 원할 경우 GuardianSdk의 unRegisterUser()로 API를 요청합니다.
회원 비활성화가 되면 GCCS 인증을 사용할 수 없으며, 회원 여부 및 상태 조회 시에도 비활성화 디바이스로 조회됩니다.
다시 활성화가 필요한 경우 기기 재등록 을 통해 활성화할 수 있습니다. 회원 비활성화를 위해서는 앱 로그인 하여 받은 token 이 필요합니다.

Parameter#

Name	Value	Description
token	String	로그인 토큰

Example#

// 회원 비활성화GuardianSdk.getInstance().unRegisterUser("{token}", new GuardianResponseCallback<ResultResponse>() {    @Override    public void onSuccess(ResultResponse result) {        Log.i(TAG, "결과코드 : " + result.rtCode);    }
    @Override    public void onFailed(ErrorResult errorResult) {        Log.e(TAG, "에러코드 : " + errorResult.getErrorCode());    }});

ResultResponse#

Key	Value	Description
rtCode	0	결과코드
rtMsg	String	결과 메시지

회원 비활성화 API 호출 성공 시 rtCode로 0이 수신되며, 해당 회원이 비활성화됩니다.

ErrorResult#

Key	Value	Description
errorCode	0	에러코드

회원 비활성화 API 호출 실패 시 errorCode 가 수신됩니다.