Documentation.md

Classes

API

Core class for danal API.

UAS

본인인증서비스 APIs

Members

ENDPOINT : object

define endpoint

NAMES : object

NAMES

API

Core class for danal API.

Kind: global class

• API
  • new API(endpoint, opts)
  • .getEndpoint() ⇒ string
  • .request(opts, cb)

new API(endpoint, opts)

Param	Type
endpoint	string
opts	object

Example

var api = new API('https://...', {...})

apI.getEndpoint() ⇒ string

return api endpiont

Kind: instance method of API

apI.request(opts, cb)

request

Kind: instance method of API

Param	Type	Description
opts	object
opts.method	object	POST, GET default is POST
opts.data	object
opts.headers	object
cb	function	cb(err, data)

UAS

본인인증서비스 APIs

Kind: global class

• UAS
  • new UAS(opts)
  • .api : API
  • .request(cb)
  • .confirm(opts, cb)
  • .redirect([name], [redirect_uri]) ⇒ function

new UAS(opts)

Param	Type	Description
opts	objects
opts.client_id	string
opts.client_secret	string
opts.redirect_uri	string
[opts.charset]	string	defaults: UTF-8
[opts.agelimit]	string

uaS.api : API

api instance

Kind: instance property of UAS

uaS.request(cb)

request tid

Kind: instance method of UAS

Param	Type
opts.userid	string
opts.token	string
[opts.redirect_uri]	string
cb	function

uaS.confirm(opts, cb)

final step authentication - Verify authentication information using an tid value

Kind: instance method of UAS

Param	Type	Description
opts	object
opts.tid	string
[opts.idenoption]	number	return value type - 0: iden, 1: dateofbirth, gender
[opts.token]	string	token string
cb	function

uaS.redirect([name], [redirect_uri]) ⇒ function

return middleware for redirect

Kind: instance method of UAS
Returns: function - express middleware

Param	Type	Description
[name]	string	key name of res.locals for the data transfer. (default: uas)
[redirect_uri]	string	landing url for uas

ENDPOINT : object

define endpoint

Kind: global variable

ENDPOINT.UAS

본인인증서비스

Kind: static property of ENDPOINT

NAMES : object

NAMES

Kind: global variable

• NAMES : object
  • .code : string
  • .message : string
  • .txtype : string
  • .client_id : string
  • .client_secret : string
  • .service : string
  • .authtype : string
  • .redirect_uri : string
  • .userid : string
  • .token : string
  • .charset : string
  • .agelimit : string
  • .cancel_uri : string
  • .use_ci : string
  • .ci_url : string
  • .bg_color : string
  • .carrier : string
  • .phonenum : string
  • .yearofbirth : string
  • .passvalue : string
  • .tid : string
  • .confirmoption : string
  • .idenoption : string
  • .name : string
  • .ci : string
  • .di : string
  • .iden : string
  • .dateofbirth : string
  • .gender : string

NAMES.code : string

RETURNCODE 결과 코드

Kind: static property of NAMES

NAMES.message : string

RETURNMSG 결과 메시지`

Kind: static property of NAMES

NAMES.txtype : string

TXTYPE

Kind: static property of NAMES

NAMES.client_id : string

CPID 가맹점 ID

Kind: static property of NAMES

NAMES.client_secret : string

CPPWD 가맹점 PWD

Kind: static property of NAMES

NAMES.service : string

SERVICE 서비스 구분

Kind: static property of NAMES

NAMES.authtype : string

AUTHTYPE 인증 TYPE

Kind: static property of NAMES

NAMES.redirect_uri : string

TARGETURL 가맹점 인증 완료 페이지 URL

Kind: static property of NAMES

NAMES.userid : string

USERID 사용자 ID

Kind: static property of NAMES

NAMES.token : string

ORDERID 가맹점 주문번호

Kind: static property of NAMES

NAMES.charset : string

CHARSET: UTF-8 (default), EUC-KR

Kind: static property of NAMES

NAMES.agelimit : string

AGELIMIT 서비스 사용 제한 나이 설정`

Kind: static property of NAMES

NAMES.cancel_uri : string

BackURL 에러 발생 및 취소시 이동할 페이지 URL

Kind: static property of NAMES

NAMES.use_ci : string

IsUseCI 가맹점 C.I 사용 여부 (Y/N)

Kind: static property of NAMES

NAMES.ci_url : string

CIURL 가맹점 C.I 이미지 URL - basic: 115x47, mobile: 77x29

Kind: static property of NAMES

NAMES.bg_color : string

BgColor 화면 color 설정시 사용

Kind: static property of NAMES

NAMES.carrier : string

IsCarrier 통신사 정보 (SKT, KTF, LGT, MVNO). 인증화면에 통신사 고정

Kind: static property of NAMES

NAMES.phonenum : string

IsDstAddr 고객전화번호 (-로 구분됨, 010-1111-1111). 인증화면에 전화번호 고정

Kind: static property of NAMES

NAMES.yearofbirth : string

YearOfBirth 고객 생년 (1982). 인증화면에 년도 정보 고정

Kind: static property of NAMES

NAMES.passvalue : string

ByPassValue 추가 전달이 필요한 값

Kind: static property of NAMES

NAMES.tid : string

TID 거래 번호

Kind: static property of NAMES

NAMES.confirmoption : string

CONFIRMOPTION CPID, ORDERID 확인 여부 (0: 미확인, default, 1: 확인)

Kind: static property of NAMES

NAMES.idenoption : string

IDENOPTION 결과 타입 설정 (0: iden 반환, 1: dateofbirth, gender 필드 리턴)

Kind: static property of NAMES

NAMES.name : string

NAME 사용자 이름

Kind: static property of NAMES

NAMES.ci : string

CI 인증 고유키

Kind: static property of NAMES

NAMES.di : string

DI SITE 연계 정보

Kind: static property of NAMES

NAMES.iden : string

IDEN 사용자 생년월일, 성별 (ex: 1401011), idenoption이 0일 경우

Kind: static property of NAMES

NAMES.dateofbirth : string

DOB 사용자 생년월일 (ex: 20140101), idenoption이 1일 경우

Kind: static property of NAMES

NAMES.gender : string

SEX 사용자 성별 (ex: 1), idenoption이 1인 경우

Kind: static property of NAMES