통합(개인) 인증 서비스를 적용하기 위한 사용자앱 Client 라이브러리 API를 정의
공통 코드 구성
| 코드 | 설명 | value |
|---|---|---|
| CODE_CREATE_CERTIFICATE | 인증서 생성 | 1 |
| CODE_ADD_AUTH | 2차 인증수단 추가 | 2 |
| CODE_DELETE_CERTIFICATE | 인증서 폐기 | 3 |
| CODE_PC_AUTH_CERTIVICATE | QR, 인증번호를 이용한 PC 인증 | 5 |
| CODE_PC_PUSH_CERTIVICATE | Push를 이용한 PC 인증 | 6 |
| CODE_PIN_MODIFY | 핀번호 변경 | 7 |
| CODE_SIGN_AUTH | 전자서명 실행 | 8 |
| CODE_CHECK_CERTIVICATE | 인증서 보유 여부 | 9 |
HAuthInterface API를 사용하기 위한 객체 생성
Example
HAuthInterface mHAuthInterface = new HAuthInterface.getInstance(context);
Arguments
Example:
HAuthInterface mHAuthInterface = HAuthInterface.getInstance(context);
mHAuthInterface.setBlockChainServerDomain(issueDomain, authDomain, pcDomain);
Arguments
Example:
HAuthInterface mHAuthInterface = HAuthInterface.getInstance(context);
mHAuthInterface.checkExistCertificate(CODE_CHECK_CERTIVICATE, hash, deviceId);
mHAuthInterface.setOnHAuthListener(new HAuthInterface.HAuthListener() {
@Override
public void successListener(int senderCode, JSONObject data) {
// senderCode로 분기 후 처리
// senderCode ==> 9, data ==>{}
}
@Override
public void errorListener(int senderCode, String errorCode) {
// senderCode로 분기 후 처리
}
});
Arguments
| Key | Type | Description |
|---|---|---|
| deviceNo | String | 휴대폰 번호 |
| String | 메일 주소 |
Example:
HAuthInterface mHAuthInterface = new HAuthInterface.getInstance(context);
mHAuthInterface.createCertification (CODE_CREATE_CERTIFICATE, hash, name, userId, deviceId, etcInfo);
mHAuthInterface.setOnHAuthListener(new HAuthInterface.HAuthListener() {
@Override
public void successListener(int senderCode, JSONObject data) {
// senderCode로 분기 후 처리
// senderCode ==> 1, data ==>{}
}
@Override
public void errorListener(int senderCode, String errorCode) {
// senderCode로 분기 후 처리
}
});
Example:
HAuthInterface mHAuthInterface = new HAuthInterface. getInstance(context);
mHAuthInterface.checkPossibleUseBiometric();
Example:
HAuthInterface mHAuthInterface = new HAuthInterface. getInstance(context);
mHAuthInterface.moveDeviceBiometricSetting();
Arguments
Returns
Return Types
| Key | Type | Description |
|---|---|---|
| code | String | 조회 성공 여부 코드 |
| result | String | 블록체인 결과 |
Example:
HAuthInterface mHAuthInterface = new HAuthInterface. getInstance(context);
JSONObject result = mHAuthInterface.getCertificateBcID();
Arguments
Returns
Return Types
| Key | Type | Description |
|---|---|---|
| code | String | 조회 성공 여부 코드 |
| result | String | 에러카운트 |
Example:
HAuthInterface mHAuthInterface = new HAuthInterface.getInstance(context);
JSONObject result = mHAuthInterface.getCertificateErrorCount();
Arguments
Returns
Return Types
| Key | Type | Description |
|---|---|---|
| code | String | 조회 성공 여부 코드 |
| result | String | 인증서 만료날짜 |
Example:
HAuthInterface mHAuthInterface = new HAuthInterface.getInstance(context);
JSONObject result = mHAuthInterface.getCertificateExpireDate();
Arguments
Example:
HAuthInterface mHAuthInterface = new HAuthInterface.getInstance(context);
mHAuthInterface.doSignatureCertificate(CODE_SIGN_AUTH, oriDoc);
mHAuthInterface.setOnHAuthListener(new HAuthInterface.HAuthListener() {
@Override
public void successListener(int senderCode, JSONObject data) {
// senderCode로 분기 후 처리
// // senderCode ==> 1, data ==>{“signedData”:”[서명정보]”, “randomNum”:”[렌덤 번호]”}
}
@Override
public void errorListener(int senderCode, String errorCode) {
// senderCode로 분기 후 처리
}
});
Arguments
Example:
HAuthInterface mHAuthInterface = new HAuthInterface.getInstance(context);
mHAuthInterface.deleteCertificate(CODE_DELETE_CERTIFICATE);
mHAuthInterface.setOnHAuthListener(new HAuthInterface.HAuthListener() {
@Override
public void successListener(int senderCode, JSONObject data) {
// senderCode로 분기 후 처리
// senderCode ==> 3, data =>{}
}
@Override
public void errorListener(int senderCode, String errorCode) {
// senderCode로 분기 후 처리
}
});
Arguments
Example:
HAuthInterface mHAuthInterface = new HAuthInterface.getInstance(context);
mHAuthInterface.modifyPinNumber(CODE_PIN_MODIFY);
mHAuthInterface.setOnHAuthListener(new HAuthInterface.HAuthListener() {
@Override
public void successListener(int senderCode, JSONObject data) {
// senderCode로 분기 후 처리
// senderCode ==> 7, data =>{}
}
@Override
public void errorListener(int senderCode, String errorCode) {
// senderCode로 분기 후 처리
}
});
Arguments
Example:
HAuthInterface mHAuthInterface = HAuthInterface.getInstance(this);
mHAuthInterface.addAuthType(CODE_ADD_AUTH, authType);
mHAuthInterface.setOnHAuthListener(new HAuthInterface.HAuthListener() {
@Override
public void successListener(int senderCode, JSONObject data) {
// senderCode로 분기 후 처리
// senderCode ==> 2, data =>{}
}
@Override
public void errorListener(int senderCode, String errorCode) {
// senderCode로 분기 후 처리
}
});
Arguments
Returns
Return Types
| Key | Type | Description |
|---|---|---|
| code | String | 조회 성공 여부 코드 |
| result | String | 인증타입(1: 지문, 2:패턴) |
Example:
HAuthInterface mHAuthInterface = HAuthInterface.getInstance(context);
JSONObject result = mHAuthInterface.getCertificateAuthType()
Example:
HAuthInterface mHAuthInterface = HAuthInterface.getInstance(context);
int result = mHAuthInterface.deleteCertificateAuthType ()
Arguments
Example:
HAuthInterface mHAuthInterface = HAuthInterface.getInstance(context);
mHAuthInterface.authPCWithPush(CODE_PC_PUSH_CERTIVICATE, pushValue);
mHAuthInterface.setOnHAuthListener(new HAuthInterface.HAuthListener() {
@Override
public void successListener(int senderCode, JSONObject data) {
// senderCode로 분기 후 처리
// senderCode ==> 5, data =>{}
}
@Override
public void errorListener(int senderCode, String errorCode) {
// senderCode로 분기 후 처리
}
});
Arguments
Example:
HAuthInterface mHAuthInterface = HAuthInterface.getInstance(context);
mHAuthInterface.authPC(CODE_PC_AUTH_CERTIVICATE, authType);
mHAuthInterface.setOnHAuthListener(new HAuthInterface.HAuthListener() {
@Override
public void successListener(int senderCode, JSONObject data) {
// senderCode로 분기 후 처리
// senderCode ==> 6, data =>{}
}
@Override
public void errorListener(int senderCode, String errorCode) {
// senderCode로 분기 후 처리
}
});
Arguments
Example:
HAuthInterface mHAuthInterface = HAuthInterface.getInstance(this);
mHAuthInterface.authPCWithSelect(CODE_PC_AUTH_CERTIVICATE);
| 결과코드 | 분류 | 에러내용 | 비고 |
|---|---|---|---|
| 0000 | 정상 | 정상 동작 | |
| 1500 | 필수값 누락 | 도메인 누락 | |
| 1501 | 필수값 누락 | 인증타입 누락 | |
| 1502 | 필수값 누락 | 디바이스 아이디 누락 | |
| 1503 | 필수값 누락 | 사용자 정보 누락 | |
| 1504 | 필수값 누락 | 사용자 이름 누락 | |
| 1505 | 필수값 누락 | 사용자 아이디 누락 | |
| 1506 | 필수값 누락 | 핀번호 누락 | |
| 1507 | 필수값 누락 | 원문 누락 | |
| 1508 | 필수값 누락 | 트렌잭션 아이디 누락 | |
| 1509 | 필수값 누락 | 클라이언트 트렌잭션 아이디 누락 | |
| 2500 | 비즈니스 오류 | 인증서가 존재하지 않음 | |
| 2501 | 비즈니스 오류 | 인증서가 존재함 | |
| 2502 | 비즈니스 오류 | 블록체인 아이디 조회 실패 | |
| 2503 | 비즈니스 오류 | 에러카운트 조회 실패 | |
| 2504 | 비즈니스 오류 | 추가인증이 존재하지 않음 | |
| 2505 | 비즈니스 오류 | 인증서 만료일자 조회 실패 | |
| 2506 | 비즈니스 오류 | 인증서 폐기 실패 | |
| 2507 | 비즈니스 오류 | 인증서 존재 여부 확인 에러 | |
| 2508 | 비즈니스 오류 | 인증서 유효성 에러 (서버) | |
| 2509 | 비즈니스 오류 | 전자서명 실패 | |
| 2514 | 비즈니스 오류 | 필수 파라미터 누락 | |
| 2530 | 비즈니스 오류 | 핀인증 화면 사용자 취소 | |
| 2531 | 비즈니스 오류 | 핀번호 암복호화 실패 (서버) | |
| 2532 | 비즈니스 오류 | 핀번호 변경 실패 | |
| 2533 | 비즈니스 오류 | 이슈챌린지 생성 실패 | |
| 2534 | 비즈니스 오류 | 인증서 저장 실패 | |
| 2535 | 비즈니스 오류 | 인증서 LOCK으로 인한 폐기 | |
| 2550 | 비즈니스 오류 | 추가인증 선택 화면 사용자 취소 | |
| 2551 | 비즈니스 오류 | 인증값 암복호화 실패 (서버) | |
| 2552 | 비즈니스 오류 | 추가인증수단 조회 실패 | |
| 2553 | 비즈니스 오류 | 추가인증수단 추가 실패 | |
| 2554 | 비즈니스 오류 | 추가인증수단 삭제 실패 | |
| 2570 | 비즈니스 오류 | 패턴인증 화면 사용자 취소 | |
| 2580 | 비즈니스 오류 | 생체(지문)인증 화면 사용자 취소 | |
| 2581 | 비즈니스 오류 | 생체인증 지원 불가 단말 | |
| 2582 | 비즈니스 오류 | 생체인증 디바이스 암호 비활성화 상태 | |
| 2583 | 비즈니스 오류 | 생체인증 디바이스 LOCK 상태 | |
| 2584 | 비즈니스 오류 | 디바이스 내 등록된 생체인증 없음 | |
| 2585 | 비즈니스 오류 | 생체인증 인증 실패 | |
| 2586 | 비즈니스 오류 | 생체인증 정보가 변경됨 | |
| 2587 | 비즈니스 오류 | 퍼미션 거부 | |
| 2588 | 비즈니스 오류 | Samsung Pass가 등록되어있지 않음 | |
| 2589 | 비즈니스 오류 | Samsung Pass내에 얼굴이 등록되어있지 않음 | |
| 2600 | 비즈니스 오류 | PC인증 선택 화면 사용자 취소 | |
| 2610 | 비즈니스 오류 | PC인증 (인증번호) 화면 사용자 취소 | |
| 2620 | 비즈니스 오류 | PC인증 (QR코드) 화면 사용자 취소 | |
| 2630 | 비즈니스 오류 | PC인증 (PUSH) 화면 사용자 취소 | |
| 9500 | 네트워크 | 네트워크 Not Found 오류 | |
| 9501 | 네트워크 | 통신 권한 오류 | |
| 9502 | 네트워크 | 통신 TimeOut | |
| 9503 | 네트워크 | URL 형식 오류 | |
| 9504 | 네트워크 | 통신 오류 |