==========
[fingerprint.hancom]
==========

XecurePass 제품에 대한 필수 API 를 정의


---------
XecurePass API
---------

hancom xecurepass finterprint 제품에 대한 3rd Party연동 기능을 제공한다.




.. _statusType:

status Type
------------


============  ===================
Type          Description             
============  ===================
PROCESSING    	진행 중
SUCCESS    		정상 처리됨
FAIL     		처리 중 문제가 발생함
============  ===================


.. _Properties Setting:

Properties Setting
--------------------------------------


	.. figure:: ../_static/api/android/fingerprint_hancom_android.png


.. _fingerprint를 위한 리소스:
		
Properties Setting 리소스 파일 
----------------------------------------------	
	
		- Hancom XecurePass 이용을 위해서는, 다음 경로의 fingerprint_assets.zip 파일을 프로젝트의 assets 폴더에 반드시 복사해야함.
		- 주의 [ 라이선스와 상관없이 공통으로 사용함  ]
			:download:`fingerprint_assets 리소스 다운로드 <../_static/api/android/fingerprint_assets.zip>`.


주의 사항
--------------------------------------

  .. code-block:: javascript
        
       - 'xp.prop 파일을 열어, ServerURL, RequestURL, ResponseURL 의 값에 대해, 정의가 필요합니다.'



등록  
--------------

.. js:function:: M.plugin('3rd_fingerprint_hancom').register( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param String setting.id: 사용자 아이디
	:param Function setting.callback: 검증 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	:param String status: 상태 ( :ref:`statusType` )
	:param Object result: 검증 결과 
		


Example:

    .. code-block:: javascript
        
        M.plugin('3rd_fingerprint_hancom').register({
            'id': 'test_id',
            callback:function(status, result){
                //console.log(result);
                alert(result);
             }
        });


인증   
--------------

.. js:function:: M.plugin('3rd_fingerprint_hancom').auth( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param String setting.id: 사용자 아이디
	:param Function setting.callback: 검증 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	:param String status: 상태 ( :ref:`statusType` )
	:param Object result: 검증 결과 
		


Example:

    .. code-block:: javascript
        
        M.plugin('3rd_fingerprint_hancom').auth({
            'id': 'test_id',
            callback:function(status, result){
                //console.log(result);
                alert(result);
             }
        });


해제   
--------------

.. js:function:: M.plugin('3rd_fingerprint_hancom').unregister( setting )

	.. versionchanged:: 2.0.0
	
	:param Object setting: 설정 정보
	:param String setting.id: 사용자 아이디
	:param Function setting.callback: 검증 결과  콜백 함수
	
	.. js:function:: callback(status, result)
		
	:param String status: 상태 ( :ref:`statusType` )
	:param Object result: 검증 결과 
		


Example:

    .. code-block:: javascript
        
        M.plugin('3rd_fingerprint_hancom').unregister({
            'id': 'test_id',
            callback:function(status, result){
                //console.log(result);
                alert(result);
             }
        });


샘플 프로젝트    
--------------

 - 아래 링크를 통해, 샘플 프로젝트를 다운로드 받을 수 있습니다. 
	:download: `fingerprint 샘플 다운로드 <http://dev.uracle.co.kr/uracle/api_sample/fingerprint.hancom.api.zip>`_