@connextable/popbill 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +64 -0
- package/dist/index.d.mts +174 -182
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +32 -31
- package/dist/index.mjs.map +1 -0
- package/package.json +10 -7
package/README.md
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# @connextable/popbill
|
|
2
|
+
|
|
3
|
+
Popbill API를 TypeScript에서 사용하기 위한 modern SDK입니다.
|
|
4
|
+
|
|
5
|
+
신규 프로젝트에서는 이 패키지를 기본 선택지로 사용합니다. `createPopbillClient`로 클라이언트를 만들고, 객체 기반 입력과 타입이 지정된 응답으로 API를 호출합니다.
|
|
6
|
+
|
|
7
|
+
## 요구사항
|
|
8
|
+
|
|
9
|
+
- Node.js 20+
|
|
10
|
+
- ESM 호환 TypeScript 도구
|
|
11
|
+
|
|
12
|
+
## 설치
|
|
13
|
+
|
|
14
|
+
```sh
|
|
15
|
+
npm install @connextable/popbill
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## 빠른 시작
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
import { createPopbillClient } from '@connextable/popbill'
|
|
22
|
+
|
|
23
|
+
const client = createPopbillClient({
|
|
24
|
+
linkId: process.env.POPBILL_LINK_ID!,
|
|
25
|
+
secretKey: process.env.POPBILL_SECRET_KEY!,
|
|
26
|
+
userId: process.env.POPBILL_USER_ID!,
|
|
27
|
+
isTest: true,
|
|
28
|
+
})
|
|
29
|
+
|
|
30
|
+
const expiration = await client.services.taxInvoice.getTaxCertificateExpirationDate({
|
|
31
|
+
businessNumber: process.env.POPBILL_CORP_NUM!,
|
|
32
|
+
})
|
|
33
|
+
|
|
34
|
+
console.log(expiration)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## 클라이언트 설정
|
|
38
|
+
|
|
39
|
+
필수 필드:
|
|
40
|
+
|
|
41
|
+
- `linkId`
|
|
42
|
+
- `secretKey`
|
|
43
|
+
- `userId`
|
|
44
|
+
|
|
45
|
+
주요 옵션:
|
|
46
|
+
|
|
47
|
+
- `isTest`: Popbill 테스트 환경 사용 여부입니다. 기본값은 `false`입니다.
|
|
48
|
+
- `useLocalTime`: 인증 시 로컬 UTC 시간을 사용할지 결정합니다. 기본값은 `true`입니다.
|
|
49
|
+
- `requestTimeoutMs`: 요청 제한시간(ms)입니다. 기본값은 `180000`입니다.
|
|
50
|
+
- `acceptEncoding`: 요청 `Accept-Encoding` 헤더입니다. 기본값은 `gzip`입니다.
|
|
51
|
+
- `acceptLanguage`: 요청 `Accept-Language` 헤더입니다.
|
|
52
|
+
- `onError`: SDK 에러 콜백입니다.
|
|
53
|
+
|
|
54
|
+
## 서비스
|
|
55
|
+
|
|
56
|
+
현재 공개 서비스 그룹:
|
|
57
|
+
|
|
58
|
+
- `client.services.taxInvoice`: 전자세금계산서 등록, 발행, 검색, 문서 URL, 첨부파일, 국세청 전송, 인증서, 설정 관련 메서드를 제공합니다.
|
|
59
|
+
|
|
60
|
+
## 관련 문서
|
|
61
|
+
|
|
62
|
+
- 저장소 가이드: [../../README.md](../../README.md)
|
|
63
|
+
- 예제: [../../examples/README.md](../../examples/README.md)
|
|
64
|
+
- 생성 SDK 문서: [../../docs/sdk/README.md](../../docs/sdk/README.md)
|