Fingerprint API

장치에 지문 스캔을 요청합니다.

int scanFingerprint ()

응답 코드

성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.

해당 API는 지문 스캔 서비스를 시작하고 즉시 반환되며, 지문 스캔이 감지되면 DeviceListner::onFingerprintScanCompleted 콜백 리스너로 데이터가 전달됩니다.
지문 스캔 진행 여부는 DeviceListner:: onFingerprintScanProgress로 확인할 수 있습니다.


장치에 지문 스캔 중지를 요청합니다.

int cancelScanFingerprint()

응답 코드

성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.


장치의 지문 서비스를 일시 정지 합니다.

int pauseFingerprintService()

응답 코드

성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드 반환합니다.


장치의 지문 서비스를 재개 합니다.

int resumeFingerprintService()

응답 코드

성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.


지문 템플릿 데이터를 서로 비교하여 동일 지문인지 확인합니다. 1:1 지문 인증 요청 시 사용할 것을 권장합니다.

int verifyFingerprint(FingerList userFingers, Finger scanFinger)

파라미터

  • userFingers: 특정 사용자의 지문 정보 리스트
  • scanFinger: (In)-비교가 필요한 스캔 받은 사용자 지문 정보, (Out)-인증 성공 된 지문 정보

응답 코드

동일한 손가락일 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.

int verifyFingerprint(Finger userFinger, Finger scanFinger)

파라미터

  • userFinger: 특정 사용자의 지문 정보
  • scanFinger: (In)-비교가 필요한 스캔 받은 사용자 지문 정보, (Out)-인증 성공 된 지문 정보

응답 코드

동일한 손가락일 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.

scanFinger 파라미터는 scanFingerprint로 입력 받은 지문 템플릿으로 생성하여 전달합니다.
verifyFingerprint가 성공적으로 수행되면 scanFinger의 id, index, isUpdated의 값이 갱신되어 전달됩니다.
isUpdated가 의미하는 것은 인증이 성공된 사용자의 지문 템플릿 업데이트가 필요하다는 의미입니다.
isUpdated 활성화시 Application의 사용자 지문 템플릿를 업데이트를 하면 슈프리마 장치의 인증 성능을 최적의 상태로 유지할 수 있습니다.


2개의 지문 템플릿 데이터를 서로 비교하여 동일 지문인지 확인합니다. 지문 등록 시 필요한 2개의 지문 템플릿의 유효성 검사 시 사용할 것을 권장합니다.

int isSameFingerprint(FingerprintTemplate template1, FingerprintTemplate template2)

파라미터

  • template1: 지문 템플릿 1
  • template2: 지문 템플릿 2

응답 코드

동일한 손가락일 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.


1:N 지문 인증에 사용될 손가락 지문 정보 템플릿 데이터를 전달합니다. 애플리케이션 구동 후 최초 1회 등록된 모든 사용자의 지문 정보를 SDK에 설정하는 용도로 사용됩니다.

int setFingerList(FingerList fingerList)

파라미터

  • fingerList: 손가락 지문 템플릿 리스트

응답 코드

성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.


1:N 지문 인증 시 사용 될 손가락 정보를 추가합니다.

int insertFinger(Finger finger)

파라미터

  • finger: 손가락 지문 정보

응답 코드

성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.


1:N 지문 인증 시 사용 될 손가락 정보를 갱신합니다.

int updateFinger(Finger finger)

파라미터

  • finger: 손가락 지문 정보

응답 코드

성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.


1:N 지문 인증 시 사용 될 손가락 정보를 삭제합니다.

int deleteFinger(Finger finger)

파라미터

  • finger: 손가락 지문 정보

응답 코드

성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.


1:N 지문 인증 시 사용 될 모든 손가락 정보를 삭제합니다.

int deleteAllFingers()

응답 코드

성공적으로 수행될 경우 SUCCESS를 반환하며 에러가 발생 시 상응하는 에러 코드를 반환합니다.