identif

Identif

A Helper to verify one's identity via personal channels

Identif는 아임포트에서 제공하는 REST API를 쉽게 활용하기 위하여 작성된 Node.js 클라이언트 입니다.

• 아임포트는 국내 PG사와의간편한 연동을 제공하는 서비스입니다.
• 이용 중 발생한 문제에 대하여 책임지지 않습니다.
• 최초 작성은 자동차 렌트 플랫폼 CARPLAT에서 사용하기 위하여 작성되었습니다.

Features

• Written in ES6 Syntax
• Promise Support
• Exception Handling with a custom error class IdentifError

Installation

$ npm install identif

Specification

• 모든 API 요청은 Promise를 반환합니다.

Fulfilled

• API 요청이 성공적으로 수행된 경우 다음과 같은 형식의 데이터를 반환합니다.

{
  "status": 200, // HTTP STATUS CODE
  "message": "", // 아임포트 API 응답 메시지 혹은 Identif 정의 메시지
  "data": {}, // 아임포트 API 응답 데이터
  "raw": {} // 아임포트 API RAW DATA
}

Rejected

• API 요청을 성공적으로 수행하지 못한 경우 항상 IdentifError 에러를 반환합니다.

identif.paySubscription(...)
  .catch((err) => {
    console.log(err.status); // HTTP STATUS CODE
    console.log(err.message); // 아임포트 API 응답 메시지 혹은 Identif 정의 메시지
    console.log(err.data); // 아임포트 API 응답 데이터
    console.log(err.raw); // 아임포트 API RAW DATA
  });

Usage

Import & Create an Instance

• identif 패키지는 Identif와 IdentifError 두 클래스를 제공합니다.

const { Identif, IdentifError } = require('identif');

// For Testing (테스트용 API KEY와 SECRET 기본 설정)
const identif = new Identif();

// For Production
const identif = new Identif({
  apiKey: 'YOUR_API_KEY',
  secret: 'YOUR_SECRET'
});

API Token

• identif는 API 요청 전에 API 토큰의 유효성을 확인 후 자동 발급/갱신하므로 직접 토큰 API를 호출할 필요가 없습니다.

// 인스턴스 생성 시 설정한 API KEY와 SECRET
identif.getToken()
  .then(...)

// 토큰 생성 시 사용될 API KEY와 SECRET 직접 지정
identif.getToken('API_KEY', 'SECRET')
  .then(...)

Subscription

• 정기 구독(Subscription)형 서비스 등에 이용할 수 있는 빌링키를 관리합니다.

// 빌링키 생성
identif.createSubscription({
  'customer_uid': 'test_uid',
  'card_number': '1234-1234-1234-1234',
  'expiry': '2021-11',
  'birth': '620201',
  'pwd_2digit': '99'
}).then(result => {
  console.log(result);
}).catch(err => {
  if (err instanceof IdentifError)
    // Handle the exception
});

// 빌링키 조회
identif.getSubscription('test_uid')
  .then(...)

// 빌링키 삭제
identif.deleteSubscription('test_uid')
  .then(...)

// 비인증 결제 (빌링키 이용)
identif.paySubscription({
  'customer_uid': 'test_uid',
  'merchant_uid': 'test_billing_key',
  'amount': 50000
}).then(result => {
    console.log(result);
}).catch(err => {
  if (err instanceof IdentifError)
    // Handle the exception
});

Links

• 아임포트
• 아임포트 API
• 아임포트 관리자
• 아임포트 매뉴얼

Contact

If you have any questions, feel free to join me at #posquit0 on Freenode and ask away. Click here to connect.

License

• MIT