PortOne v2 API Client (Unofficial) ·

이 라이브러리는 PortOne에서 제공하는 v2 API를 쉽게 이용할 수 있는 TypeScript/JavaScript Client이에요. B2B 서비스 API(Alpha)를 제외한 모든 최신 v2 API에 대한 요청을 지원해요.

잠깐! 이 라이브러리를 사용하시기 전 아래 내용을 확인해 주세요!

이 라이브러리는 PortOne v2를 이용하시는 가맹점에서만 사용할 수 있습니다.단, PortOne v2가 모든 PG사를 지원하지 않기 때문에, 지원하는 PG사를 반드시 확인하시고 이용해 주시기 바랍니다.지원하는 PG사는 여기에서 확인하실 수 있습니다.

설치하기

$ npm install --save portone

사용 예제 (전체 소스 확인)

// 포트원 API Client 임포트
import {PortOne} from 'portone';

// 클래스 정의
const portOne = new PortOne();

// ...

// API 시크릿으로 API 로그인
await portOne.login({
  storeId: 'store-e4038486-8d83-41a5-acf1-844a009e0d94',
  authorization: {
    type: 'SECRET',
    secret: 'MY_API_SECRET',
  }
})

// ...

// 결제 정보 불러오기 (예시)
const payment = await portOne.payments.getPayment({
  paymentId: '79dfbd22-d66b-4cc4-b350-ffa2fe2fec42',
});

if (payment.data) {
  // 데이터 처리
} else {
  // 에러 핸들링
}

기여하기

이 라이브러리는 누구나 기여할 수 있어요. 라이브러리에 기여하고 싶다면 아래 문서를 참고해주세요. (기여 가이드라인)

참고 사항

이 라이브러리는 PortOne에서 만든 공식 라이브러리가 아니며, 공정사용의 범위 내에서 비영리를 목적으로 제작되었습니다. PortOne 및 포트원은 (주)코리아포트원의 상표입니다.

라이선스

Apache License 2.0. LICENSE 파일을 참고하세요. 본 레포지토리를 상업적 용도로 Fork/재배포 하는 행위를 금합니다.