From 543a53a8876c96e49a5838b7775c2faca4e839e3 Mon Sep 17 00:00:00 2001 From: LimJiGyu Date: Mon, 25 Mar 2024 15:10:39 +0900 Subject: [PATCH] feat: ESM url in v2-sdk readme & remove mention to access_token in v2 --- src/content/docs/ko/ready/readme.mdx | 53 +- .../_components/sdk-installation.mdx | 61 +++ src/content/docs/ko/v2-payment/authpay.mdx | 62 +-- .../v2-payment/v2-sdk/billing-key-request.mdx | 2 +- .../v2-sdk/billing-key-response.mdx | 2 +- .../v2-sdk/identity-verification-request.mdx | 518 +++++++++--------- .../v2-sdk/identity-verification-response.mdx | 2 +- .../ko/v2-payment/v2-sdk/payment-request.mdx | 2 +- .../ko/v2-payment/v2-sdk/payment-response.mdx | 2 +- .../docs/ko/v2-payment/v2-sdk/readme.mdx | 40 +- 10 files changed, 332 insertions(+), 412 deletions(-) create mode 100644 src/content/docs/ko/v2-payment/_components/sdk-installation.mdx diff --git a/src/content/docs/ko/ready/readme.mdx b/src/content/docs/ko/ready/readme.mdx index 0ab47ec62..98f1aecb3 100644 --- a/src/content/docs/ko/ready/readme.mdx +++ b/src/content/docs/ko/ready/readme.mdx @@ -11,7 +11,6 @@ import VersionGate from "~/components/gitbook/VersionGate.astro"; import Hint from "~/components/Hint.astro"; import image07 from "./_assets/apiver_v1.png"; -import apiVerV2 from "./_assets/apiver_v2.png"; import image4 from "./_assets/apply1.png" import image01 from "./_assets/channel1.png"; import image02 from "./_assets/channel2.png"; @@ -43,7 +42,6 @@ import image12 from "./_assets/pg/tosspayments.png"; import image9 from "./_assets/pg/welcome.png"; import image10 from "./_assets/pg/welcome1.png"; import image2 from "./_assets/signup.png"; -import storeid from "./_assets/storeid.png"; import IntegrationPaypalV2 from './_components/integration-guide/paypal-v2.mdx'; import IntegrationTosspayments from './_components/integration-guide/tosspayments.mdx'; @@ -620,58 +618,11 @@ import IntegrationTosspayments from './_components/integration-guide/tosspayment **REST API Key, REST API Secret란?** - - V1 API 호출 시 사용되는 Access Token을 발급할 때 사용되는 값입니다. - - REST API Secret은 재발급이 가능하며, 재발급 즉시 기존의 Secret은 사용이 불가능합니다. + - API 호출 시 인증을 위해 필요한 값입니다. [인증 방식](https://developers.portone.io/api/rest-v2)을 참고해 주세요. - REST API Key, REST API Secret **결제 거래 건을 컨트롤할 수 있는 민감 정보**로 외부로 유출되지 않도록 주의가 필요합니다. - - - - - ### 4-1. 스토어 아이디(Store ID) 복사하기 - - 포트원을 이용한 결제 연동 시 필요한 스토어 아이디(Store ID)를 복사할 수 있습니다. - -
- - - 관리자 콘솔 화면에서 \[결제 연동] → \[연동 관리] 화면에서 스토어 아이디를 복사할 수 있습니다. - - - **스토어 아이디(Store ID)란?** - - - 포트원 가입 시 \[대표 상점]이 생성되며, 자동으로 생성되는 고유값 입니다. - - 추가로 하위 상점을 생성하는 경우 **상점마다 고유하게 부여**됩니다. - - 결제창 연동 시 사용되며, 결제 호출 시 `storeId` 파라미터에 해당 값을 넣어야 합니다. - - **기술 문의 시 해당 값을 공유**해 주시면 빠르게 문제 해결을 도와드릴 수 있습니다. - - - ### 4-2. V2 API Secret 발급하기 - - V2 API를 연동하기 위해서는 V2 API Secret을 별도로 발급한 후 사용이 가능합니다. - -
- - - 관리자 콘솔 화면에서 \[결제연동] → \[연동 관리] → \[식별코드·API Keys] 메뉴에서 \[V2 API]를 선택합니다. - - `새로운 API Secret 발급`을 클릭합니다. - - Secret 목록에 표시될 `Secret 이름`을 입력하고 `만료 기한`을 선택한 후 `생성`을 클릭합니다. - - 생성된 Secret을 복사합니다. `API Secret을 확인했습니다`를 누른 후엔 Secret 값을 확인할 수 없으니 주의해 주세요. - - - API Secret 발급 직후에만 값을 확인할 수 있습니다. 페이지를 벗어나면 API Secret 확인이 불가하오니 복사한 후 임의의 장소에 저장하여 사용하세요. - 만약, API Secret 값을 잊어버리신 경우 새로 발급받아 사용해야 합니다. - - - - **API Secret이란?** - - - API 호출 시 사용되는 Access Token을 발급할 때 사용되는 값입니다. - - V2 API Secret을 발급받으신 후, 이를 이용해 [API Secret을 이용한 토큰 발급](/api/rest-v2/auth#post%20%2Flogin%2Fapi-secret) API를 호출하시면
**Access Token**을 발급받으실 수 있습니다. -
- - - API Secret은 **결제 거래 건을 컨트롤할 수 있는 민감 정보**로 외부로 유출되지 않도록 주의가 필요합니다. + - API Secret은 **결제 거래 건을 컨트롤할 수 있는 민감 정보**로 고객사 서버에서만 사용되어야 하며, 브라우저 등 외부에 노출되어서는 안 됩니다. diff --git a/src/content/docs/ko/v2-payment/_components/sdk-installation.mdx b/src/content/docs/ko/v2-payment/_components/sdk-installation.mdx new file mode 100644 index 000000000..6dc106a06 --- /dev/null +++ b/src/content/docs/ko/v2-payment/_components/sdk-installation.mdx @@ -0,0 +1,61 @@ +import Tab from "~/components/gitbook/tabs/Tab.astro"; +import Tabs from "~/components/gitbook/tabs/Tabs.astro"; +import Hint from "~/components/Hint.astro"; +import * as prose from '~/components/prose'; + +export const components = prose; + +포트원 V2 SDK는 npm 레지스트리와 CDN을 통해 배포되고 있습니다. + +- npm, yarn 등 패키지 매니저를 사용한다면 의존 + 대상으로 [@portone/browser-sdk](https://www.npmjs.com/package/@portone/browser-sdk)를 추가하세요. + +- 패키지 매니저를 사용하지 않는다면 ` + ``` + + ` -``` - -` -``` - - - +