/iamport-rest-client-nodejs

NodeJS사용자를 위한 아임포트 REST API 연동 모듈입니다.

Primary LanguageJavaScriptMIT LicenseMIT

Iamport

Build Status npm version Dependency Status

아임포트는 특정 서비스와 국내 PG사와의 연동을 간편하게 연결해주는 서비스입니다. 이 모듈은 아임포트에서 제공하는 REST API를 Node.js®로 구현한 클라이언트입니다. 아임포트의 자세한 내용은 여기를 참고하시기 바랍니다.

Features

  • 모든 함수는 Promise를 반환

Requirements

Installation

$ npm install --save iamport

Usage

var Iamport = require('iamport');
var iamport = new Iamport({
  impKey: 'your API key',
  impSecret: 'your API Secret key'
});

// 아임포트 고유 아이디로 결제 정보를 조회
iamport.payment.getByImpUid({
  imp_uid: 'your imp_uid'  
}).then(function(result){
  // To do
}).catch(function(error){
  // handle error
});

// 상점 고유 아이디로 결제 정보를 조회
iamport.payment.getByMerchant({
  merchant_uid: 'your merchant_uid'  
})

// 상태별 결제 정보 조회
iamport.payment.getByStatus({
  payment_status: 'your payment_status'  
})

Available resources & methods

Where you see params it is a plain JavaScript object

  • certification
  • payment
  • subscribe
  • subscribe_customer
  • vbank

Contribution

  • 이 프로젝트는 누구나 참여 가능합니다.
  • 버그나 개선점 및 의견 등은 이슈 및 Pull Request를 활용해주세요.

Conventions

Links

License