echoss stamp

12cm echoss SDK

## Installation npm install 12cm-echoss-sdk@latest
## echoss Client SDK ### Overview This document introduces echoss Client SDK's configuration and it's how to use based on Vue. ### Usage #### HTML ```html
``` #### Script ```javascript import echoss from '12cm-echoss-sdk/echoss-lite/index.js' export default { components: { echoss }, created () { echoss.initializeSuccess = () => { echoss.Stamp.init(() => { // Initialize Success }, (errorCode, errorMessage) => { // Initialize Failure }) } echoss.setLanguageCode(echoss.LANGUAGE_CODE_TYPE.KOREAN) echoss.initialize(result.apiKey, echoss.REGION_CODE_TYPE.KOREA, 'app-container') echoss.Stamp.onBeforeStamp = () => { // When the stamp is recognized on the screen, the following function is called. } echoss.Stamp.onException = (errorCode, errorMessage) => { // If an exception case occurs that cannot authenticate the stamp, the following callback function is called. } echoss.Stamp.onError = (errorCode, errorMessage) => { // When the stamp is not available on current web page or needs to be recognized again, the following callback function is called. } echoss.Stamp.onStamp = (stampParams) => { // If the stamp data is encrypted after the stamp recognition function is called, the following function is automatically called. } } } ``` #### Initialization Region
Region Code
Korea echoss.REGION_CODE_TYPE.KOREA
Japan echoss.REGION_CODE_TYPE.JAPAN
China echoss.REGION_CODE_TYPE.CHINA
Taiwan echoss.REGION_CODE_TYPE.TAIWAN
Europe echoss.REGION_CODE_TYPE.EUROPE
AP-South East1
(Singapore, Malaysia) 		echoss.REGION_CODE_TYPE.APSE1
AP-South East2
(Indonesia, Vietnam) 		echoss.REGION_CODE_TYPE.APSE2
#### Language
Language Code
Korean echoss.LANGUAGE_CODE_TYPE.KOREAN
English echoss.LANGUAGE_CODE_TYPE.ENGLISH
Japanese echoss.LANGUAGE_CODE_TYPE.JAPANESE
Simplified Chinese echoss.LANGUAGE_CODE_TYPE.CHINESE
Traditional Chinese echoss.LANGUAGE_CODE_TYPE.TAIWAN

## echoss Service Provider ### Overview This document explains how to use service page and stamps with the echoss Certification Kit. ### Usage #### HTML ```html ``` #### Script ```javascript import EchossCertificationKit from '12cm-echoss-sdk/echoss-provider/index.vue' export default { components: { EchossCertificationKit }, data() { return { license: 'ENTER_LICENSE_CODE', region: 'KOREA', language: 'KOREAN', usercode: 'ENTER_USER_CODE', merchantcode: 'ENTER_MERCHANT_CODE', options: { backgroundcolor: '#000000', opacity: 0.4, description: 'Please take a stamp', loading: true, animation: true, echossicon: true } } }, methods: { onInitializeSuccess() { // Initialize Success }, onInitializeError(errorCode, errorMessage) { // Initialize Failure }, onBeforeStamp() { // When the stamp is recognized, the following callback function would be called. }, onStampError(errorCode, errorMessage) { // Following callback function would be called if the users cannot use the service in Service Page or close it. }, onStampSuccess(response) { // Following callback function would be called if stamp is verified successfully. Result consists of license ID, user code and token information. }, onClose() { // When users closer the provider page. } } } ``` #### Parameter Specification
Parameter Description
license License ID provided by 12cm
region Set the region for API server access.
language Set the language for API messages.
usercode User unique code of clients' membership system. When all users using same number attempt simultaneous authentication at one service, it can cause error because the system can misunderstand that one user is causing improper authentication.
merchantcode Merchant Unique Code. Available to input merchant code, brand code, merchant unique code provided by 12CM. Or can deliver in blank incase the merchant cannot manage unique merchant number.
options etc options.
#### options
Parameter Description
backgroundcolor Change the background color in the service page.
opacity Change the background opacity in the service page.
description Change the exposed text in the service page.
loading On the Services page, set whether to show or not the loading effect for stamp recognition. Enter 'true' to allow loading effects in the request parameter, or 'false' if not. The
default value is true.
animation On the Services page, set whether to show or not the background animation. Enter 'true' to expose animation on background, or 'false' if not.
The default value is true.
echossicon On the Services page, set whether to use or not the echoss Icon. Enter 'true' to use echoss Icon in the request parameter, or 'false' if not.
The default value is true.
#### Initialization Region
Region Code
Korea KOREA
Japan JAPAN
China CHINA
Taiwan TAIWAN
Europe EUROPE
AP-South East1
(Singapore, Malaysia) 		APSE1
AP-South East2
(Indonesia, Vietnam) 		APSE2
#### Language
Language Code
Korean KOREAN
English ENGLISH
Japanese JAPANESE
Simplified Chinese SIMPLIFIED_CHINESE
Traditional Chinese TRADITIONAL_CHINESE