https://github.com/kms0219kms/portone-restv2-client-nodejs

PortOne (Korea) V2 RestApi Library for Node.js
https://github.com/kms0219kms/portone-restv2-client-nodejs

Last synced: 11 days ago
JSON representation

PortOne (Korea) V2 RestApi Library for Node.js

• Host: GitHub
• URL: https://github.com/kms0219kms/portone-restv2-client-nodejs
• Owner: kms0219kms
• License: apache-2.0
• Created: 2024-03-27T03:30:40.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-08-08T15:01:01.000Z (3 months ago)
• Last Synced: 2024-08-09T17:26:30.110Z (3 months ago)
• Language: TypeScript
• Size: 296 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# [PortOne](https://portone-landing.vercel.app/korea/ko) v2 API Client (Unofficial) · [![Apache 2.0 License](https://img.shields.io/badge/license-Apache2.0-blue.svg)](./LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](.github/CONTRIBUTING.md)

## DEPRECATION NOTICE

이 라이브러리는 [PortOne 공식 SDK](https://github.com/portone-io/server-sdk-js.git) 가 출시되는 대로, Deprecation 될 예정입니다.


신규로 연동하시는 경우, 위 공식 SDK를 사용해 주세요.



이 라이브러리는 [PortOne](https://portone-landing.vercel.app/korea/ko)에서 제공하는 v2 API를 쉽게 이용할 수 있는 TypeScript/JavaScript Client이에요.


B2B 서비스 API(Alpha)를 제외한 모든 최신 v2 API에 대한 요청을 지원해요.

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

이 라이브러리는 [PortOne v2](https://developers.portone.io/api/rest-v2?v=v2)를 이용하시는 가맹점에서만 사용할 수 있습니다.
단, PortOne v2가 모든 PG사를 지원하지 않기 때문에, 지원하는 PG사를 반드시 확인하시고 이용해 주시기 바랍니다.
지원하는 PG사는 [여기](https://developers.portone.io/docs/ko/v2-payment/v2?v=v2#사용-가능한-pg사)에서 확인하실 수 있습니다.

## 설치하기

```sh

$ npm install --save portone

```

## 사용 예제 ([전체 소스 확인](./examples/getPayment.ts))

```ts

// 포트원 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 {

  // 에러 핸들링

}

```

## 기여하기

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

## 참고 사항

이 라이브러리는 PortOne에서 만든 공식 라이브러리가 아니며, 공정사용의 범위 내에서 비영리를 목적으로 제작되었습니다.


`PortOne` 및 `포트원`은 (주)코리아포트원의 상표입니다.

## 라이선스

Apache License 2.0. [LICENSE](./LICENSE) 파일을 참고하세요.


본 레포지토리를 상업적 용도로 Fork/재배포 하는 행위를 금합니다.