@portone/mcp-server 0.13.0

package/assets/docs/opi/ko/extra/identity-verification/v1/credit-auth/3.md

@@ -0,0 +1,75 @@
+---
+title: 3. 인증 완료정보 전달하기
+description: 신용카드 본인인증 이후 획득된 정보를 처리하는 방법을 안내합니다.
+targetVersions:
+  - v1
+---
+
+인증 프로세스가 완료되면 반환되는 응답 객체(**`rsp`**)의 인증 성공 여부에 따라 처리 로직을 **`callback`** 함수에 작성합니다. 요청이 성공했을 경우에 **인증번호(`imp_uid`)를 서버에 전달**하는 로직을 다음 예제를 참고하여 작성합니다. 인증 성공시 [**반환되는 값**](https://developers.portone.io/sdk/ko/v1-sdk/javascript-sdk/cft-rt)을 확인하세요
+
+## 1. callback Data 전달 예제
+
+<div class="tabs-container">
+
+<div class="tabs-content" data-title="JavaScript">
+
+```ts title="client-side"
+IMP.certification(
+  {
+    /* ...중략... */
+  },
+  function (rsp) {
+    // callback
+    if (rsp.success) {
+      // 인증 성공 시
+      // jQuery로 HTTP 요청
+      jQuery.ajax({
+        url: "{서버의 인증 정보를 받는 endpoint}",
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        data: { imp_uid: rsp.imp_uid },
+      });
+    } else {
+      alert("인증에 실패하였습니다. 에러 내용: " + rsp.error_msg);
+    }
+  },
+);
+```
+
+</div>
+
+<div class="tabs-content" data-title="JS ES Next">
+
+```ts title="client-side"
+IMP.certification(
+  {
+    /* ...중략... */
+  },
+  (rsp) => {
+    // callback
+    if (rsp.success) {
+      // 인증 성공 시 axios로 HTTP 요청
+      axios({
+        url: "{서버의 인증 정보를 받는 endpoint}",
+        method: "post",
+        headers: { "Content-Type": "application/json" },
+        data: { imp_uid: rsp.imp_uid },
+      });
+    } else {
+      alert(`인증에 실패하였습니다. 에러 내용: ${rsp.error_msg}`);
+    }
+  },
+);
+```
+
+</div>
+
+</div>
+
+## 2. 리디렉션 전달 예제
+
+`IMP.`**`certification`** 호출 시 설정한 **`m_redirect_url`** 로 인증 정보와 함께 다음과 같이 리디렉션됩니다.
+
+```http title="Query String"
+GET {m_redirect_url}?imp_uid={}&merchant_uid={본인인증 건의 merchant_uid}&success={true 또는 false}
+```

package/assets/docs/opi/ko/extra/identity-verification/v1/credit-auth/4.md

@@ -0,0 +1,134 @@
+---
+title: 4. 인증정보 조회 및 활용하기
+description: 인증정보를 획득하고 활용하는 방법을 안내합니다.
+targetVersions:
+  - v1
+---
+
+본인인증 완료이후 획득한 \*\*`imp_uid`\*\*를 이용하여 고객 인증정보를 조회할 수 있습니다.
+
+## **STEP 01.** 인증정보(imp\_uid) 서버단에서 획득하기
+
+아래는 본인인증 앞단에서 넘어온 값을 서버단에서 수신받은 예제 입니다.
+
+<div class="tabs-container">
+
+<div class="tabs-content" data-title="Node.js(팝업방식)">
+
+```ts title="server-side"
+app.use(bodyParser.json());
+// "/certifications"에 대한 POST 요청을 처리하는 controller
+app.post("/certifications", async (request, response) => {
+  // request의 body에서 imp_uid 추출
+  const { imp_uid } = request.body;
+});
+```
+
+</div>
+
+<div class="tabs-content" data-title="Node.js(리디렉션 방식)">
+
+```ts title="server-side"
+app.use(bodyParser.json());
+// "/certifications/redirect"에 대한 GET 요청을 처리하는 controller
+app.get("/certifications/redirect", async (request, response) => {
+  const { imp_uid } = request.query; // request의 query에서 imp_uid 추출
+});
+```
+
+</div>
+
+</div>
+
+## **STEP 02.** 인증 정보 조회하기
+
+포트원 서버에서 인증 정보를 조회하기 위해서 먼저 [**REST API access token**](https://developers.portone.io/api/rest-v1/auth?v=v1#post%20%2Fusers%2FgetToken)을 발급받습니다. 발급받은 액세스 토큰(`access_token`)과 인증번호(`imp_uid`)로 **본인인증 결과조회 REST API** 를 호출하여 인증 정보를 조회하는 예제입니다.
+
+```ts title="server-side"
+app.use(bodyParser.json());
+// "/certifications"에 대한 POST 요청을 처리하는 controller
+app.post("/certifications", async (request, response) => {
+  const { imp_uid } = request.body; // request의 body에서 imp_uid 추출
+  try {
+    // 인증 토큰 발급 받기
+    const getToken = await axios({
+      url: "https://api.iamport.kr/users/getToken",
+      // POST method
+      method: "post",
+      // "Content-Type": "application/json"
+      headers: { "Content-Type": "application/json" },
+      data: {
+        imp_key: "imp_apikey", // REST API키
+        imp_secret:
+          "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f", // REST API Secret
+      },
+    });
+    const { access_token } = getToken.data; // 인증 토큰
+    // imp_uid로 인증 정보 조회
+    const getCertifications = await axios({
+      // imp_uid 전달
+      url: `https://api.iamport.kr/certifications/${imp_uid}`,
+      // GET method
+      method: "get",
+      // 인증 토큰 Authorization header에 추가
+      headers: { Authorization: access_token },
+    });
+    const certificationsInfo = getCertifications.data; // 조회한 인증 정보
+    // ...
+  } catch (e) {
+    console.error(e);
+  }
+});
+```
+
+## **STEP 03.** 인증 정보 활용하기
+
+조회한 인증 정보에서 다음의 고객 정보를 추출하는 서비스 코드 예제입니다.
+
+- `name`: 이름
+- `gender`: 성별
+- `birth`: 생년월일
+- `unique_key`: CI 값과 동일. 온라인 주민번호와 같은 개인고유식별키
+- `unique_in_site`: DI 값과 동일. 상점아이디(사이트)별로 할당되는 식별키
+
+<div class="hint" data-style="info">
+
+**unique\_key와 unique\_in\_site**
+
+본인인증에 사용된 신용카드가 여러 장이어도 신용카드 소유자가 같다면 매번 `unique_key` 와 `unique_in_site`는 같은 값이 응답됩니다.
+
+</div>
+
+```ts title="Node.js"
+// "/certifications"에 대한 POST 요청을 처리하는 controller
+app.post("/certifications", async (request, response) => {
+  const { imp_uid } = request.body; // request의 body에서 imp_uid 추출
+  try {
+    // 인증 토큰 발급 받기
+    /* ...중략... */
+    // imp_uid로 인증 정보 조회
+    /* ...중략... */
+    const certificationsInfo = getCertifications.data; // 조회한 인증 정보
+    // unique_key: 개인식별 고유 키, unique_in_site: 사이트 별 개인식별 고유 키
+    const { unique_key, unique_in_site, name, gender, birth } =
+      certificationsInfo;
+    // 연령 제한 로직
+    if (new Date(birth).getFullYear() <= 1999) {
+      // 연령 만족
+    } else {
+      // 연령 미달
+    }
+    // 1인 1계정 허용 로직
+    // DB에서 unique_key 조회 후 가입여부 검사
+    Users.find({ certificationKey: unique_key }).then((user) => {
+      if (!user) {
+        // 신규 고객
+      } else {
+        // 이미 가입된 고객
+      }
+    });
+  } catch (e) {
+    console.error(e);
+  }
+});
+```

package/assets/docs/opi/ko/extra/identity-verification/v1/credit-auth/readme.md

@@ -0,0 +1,17 @@
+---
+title: 신용카드 본인인증 연동
+description: 신용카드 본인인증 기능을 구현하는 방법을 설명합니다.
+targetVersions:
+  - v1
+---
+
+<div class="hint" data-style="info">
+
+신용카드본인인증 서비스는 현재 서비스 중단으로 신규계약이 불가합니다.\
+(기존에 이용중인 고객사는 지속 사용 가능)
+
+</div>
+
+**신용카드 본인인증 서비스란** 신용카드 인증을 통하여 해당 신용카드 소지자의 개인정보(이름, 생년월일, 성별, 외국인여부, KISA 고유식별값)를 확인할 수 있는 서비스입니다.
+
+(이미지 첨부: 신용카드 본인인증 화면 예시)

package/assets/docs/opi/ko/extra/identity-verification/v1/phone/1.md

@@ -0,0 +1,37 @@
+---
+title: 1. 본인인증 준비하기
+description: 휴대폰 본인인증 연동을 위한 준비
+targetVersions:
+  - v1
+versionVariants:
+  v2: /opi/ko/extra/identity-verification/readme-v2
+---
+
+## 1. 포트원 SDK 설치하기 <span id="sdk-installation" />
+
+포트원은 다양한 PG의 본인인증창을 통일된 방법으로 호출할 수 있도록 자바스크립트 SDK를 제공합니다.
+브라우저에서 포트원 SDK를 호출하여 본인인증을 진행하게 됩니다.
+
+<!-- VERSION-SPECIFIC: V1 ONLY CONTENT START -->
+
+결제창 연동을 진행할 주문 페이지에 아래 JS 라이브러리를 추가합니다.
+
+```html
+<script src="https://cdn.iamport.kr/v1/iamport.js"></script>
+```
+
+[포트원 라이브러리 추가하기](https://www.youtube.com/watch?v=FLyOmbtnr48)
+
+<!-- VERSION-SPECIFIC: V1 ONLY CONTENT END -->
+
+## 2. SDK 초기화하기 <span id="sdk-installation" />
+
+포트원 SDK를 사용하여 결제창을 호출하려면, 먼저 포트원 SDK를 초기화하여야 합니다.
+
+먼저, 관리자 콘솔의 결제 연동 페이지에서 **고객사 식별코드**를 확인해 주세요.
+
+그리고 결제창을 호출할 페이지에서 다음과 같이 포트원 SDK를 초기화합니다.
+
+```ts title="client-side"
+IMP.init("{고객사 식별코드}"); // 예: imp00000000
+```

package/assets/docs/opi/ko/extra/identity-verification/v1/phone/2.md

@@ -0,0 +1,86 @@
+---
+title: 2. 본인인증창 호출하기
+description: 본인인증 창 호출방법을 안내합니다.
+targetVersions:
+  - v1
+versionVariants:
+  v2: /opi/ko/extra/identity-verification/readme-v2
+---
+
+휴대폰 본인인증은 아래 두가지 방법으로 호출할 수 있습니다.
+
+> **팝업**(Default) 방식
+>
+> 휴대폰 본인인증 팝업창이 열리고 본인인증를 완료하면 두 번째 인자로 지정된 `callback` 함수가 실행됩니다.
+
+> **리디렉션**(redirect)방식(**Mobile** 환경에서만 적용)
+>
+> 모바일 환경에서 `param.popup`을 **`false`**`(기본값)`로 설정하면 본인인증 페이지로 리디렉션되고 본인인증을 완료하면 `param.m_redirect_url`로 다시 리디렉션됩니다.
+>
+> `param.popup`을 **`true`** 로 설정하면 팝업(기본) 방식으로 작동합니다.
+>
+> **WebView 등 팝업이 차단되는 환경**에서는 `popup : false`로 설정하는 것을 권장합니다.
+
+아래는 휴대폰 본인인증창을 호출하는 예제입니다.
+
+<div class="tabs-container">
+
+<div class="tabs-content" data-title="JavaScript">
+
+```ts title="client-side"
+// IMP.certification(param, callback) 호출
+IMP.certification(
+  {
+    // param
+    channelKey: "{콘솔 내 연동 정보의 채널키}",
+    // 주문 번호
+    merchant_uid: "ORD20180131-0000011",
+    // 모바일환경에서 popup:false(기본값) 인 경우 필수
+    m_redirect_url: "{리디렉션 될 URL}",
+    // PC환경에서는 popup 파라미터가 무시되고 항상 true 로 적용됨
+    popup: false,
+  },
+  function (rsp) {
+    // callback
+    if (rsp.success) {
+      // 인증 성공 시 로직
+    } else {
+      // 인증 실패 시 로직
+    }
+  },
+);
+```
+
+휴대폰 본인인증창을 호출하기 위한 [**파라미터 목록**](https://developers.portone.io/sdk/ko/v1-sdk/javascript-sdk/cft)을 확인하세요
+
+</div>
+
+<div class="tabs-content" data-title="JS ES Next">
+
+```ts title="client-side"
+// IMP.certification(param, callback) 호출
+IMP.certification(
+  {
+    // param
+    channelKey: "{콘솔 내 연동 정보의 채널키}",
+    // 주문 번호
+    merchant_uid: "ORD20180131-0000011",
+    // 모바일환경에서 popup:false(기본값) 인 경우 필수
+    m_redirect_url: "{리디렉션 될 URL}",
+    // PC환경에서는 popup 파라미터가 무시되고 항상 true 로 적용됨
+    popup: false,
+  },
+  (rsp) => {
+    // callback
+    if (rsp.success) {
+      // 인증 성공 시 로직
+    } else {
+      // 인증 실패 시 로직
+    }
+  },
+);
+```
+
+</div>
+
+</div>

package/assets/docs/opi/ko/extra/identity-verification/v1/phone/3.md

@@ -0,0 +1,77 @@
+---
+title: 3. 인증 완료정보 전달하기
+description: 휴대폰 본인인증 이후 획득된 정보를 처리하는 방법을 안내합니다.
+targetVersions:
+  - v1
+versionVariants:
+  v2: /opi/ko/extra/identity-verification/readme-v2
+---
+
+인증 프로세스가 완료되면 반환되는 응답 객체(**`rsp`**)의 인증 성공 여부에 따라 처리 로직을 **`callback`** 함수에 작성합니다. 요청이 성공했을 경우에 **인증번호(`imp_uid`)를 서버에 전달**하는 로직을 다음 예제를 참고하여 작성합니다. 인증 성공시 [**반환되는 값**](https://developers.portone.io/sdk/ko/v1-sdk/javascript-sdk/cft-rt)을 확인하세요
+
+## 1. callback Data 전달 예제
+
+<div class="tabs-container">
+
+<div class="tabs-content" data-title="JavaScript">
+
+```ts title="client-side"
+IMP.certification(
+  {
+    /* ...중략... */
+  },
+  function (rsp) {
+    // callback
+    if (rsp.success) {
+      // 인증 성공 시 jQuery로 HTTP 요청
+      jQuery.ajax({
+        url: "{서버의 인증 정보를 받는 endpoint}",
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        data: { imp_uid: rsp.imp_uid },
+      });
+    } else {
+      alert("인증에 실패하였습니다. 에러 내용: " + rsp.error_msg);
+    }
+  },
+);
+```
+
+</div>
+
+<div class="tabs-content" data-title="JS ES Next">
+
+```ts title="client-side"
+IMP.certification(
+  {
+    /* ...중략... */
+  },
+  (rsp) => {
+    // callback
+    if (rsp.success) {
+      // 인증 성공 시
+      // axios로 HTTP 요청
+      axios({
+        url: "{서버의 인증 정보를 받는 endpoint}",
+        method: "post",
+        headers: { "Content-Type": "application/json" },
+        data: { imp_uid: rsp.imp_uid },
+      });
+    } else {
+      alert(`인증에 실패하였습니다. 에러 내용: ${rsp.error_msg}`);
+    }
+  },
+);
+```
+
+</div>
+
+</div>
+
+## 2. 리디렉션 전달 예제
+
+`IMP.`**`certification`** 호출 시 설정한 **`m_redirect_url`** 로 인증 정보와 함께 다음과 같이 리디렉션됩니다.
+
+```http title="Query String"
+GET {m_redirect_url}?imp_uid={}&merchant_uid={본인인증 건의 merchant_uid}&success={true 또는 false}
+```

package/assets/docs/opi/ko/extra/identity-verification/v1/phone/4.md

@@ -0,0 +1,149 @@
+---
+title: 4. 인증정보 조회 및 활용하기
+description: 인증정보를 획득하고 활용하는 방법을 안내합니다.
+targetVersions:
+  - v1
+versionVariants:
+  v2: /opi/ko/extra/identity-verification/readme-v2
+---
+
+휴대폰 본인인증 완료이후 획득한 `imp_uid`를 이용하여 고객 인증정보를 조회할 수 있습니다.
+
+## **STEP 01.** 인증정보(imp\_uid) 서버단에서 획득하기
+
+아래는 휴대폰 본인인증 앞단에서 넘어온 값을 서버단에서 수신받은 예제 입니다.
+
+<div class="tabs-container">
+
+<div class="tabs-content" data-title="Node.js(팝업방식)">
+
+```ts title="server-side"
+app.use(bodyParser.json());
+// "/certifications"에 대한 POST 요청을 처리하는 controller
+app.post("/certifications", async (request, response) => {
+  // request의 body에서 imp_uid 추출
+  const { imp_uid } = request.body;
+});
+```
+
+</div>
+
+<div class="tabs-content" data-title="Node.js(리디렉션 방식)">
+
+```ts title="server-side"
+app.use(bodyParser.json());
+// "/certifications/redirect"에 대한 GET 요청을 처리하는 controller
+app.get("/certifications/redirect", async (request, response) => {
+  const { imp_uid } = request.query; // request의 query에서 imp_uid 추출
+});
+```
+
+</div>
+
+</div>
+
+## **STEP 02.** 인증 정보 조회하기
+
+포트원 서버에서 인증 정보를 조회하기 위해서 먼저 [**REST API access token**](https://developers.portone.io/api/rest-v1/auth?v=v1#post%20%2Fusers%2FgetToken)을 발급받습니다. 발급받은 액세스 토큰(`access_token`)과 인증번호(`imp_uid`)로 **본인인증 결과조회 REST API** 를 호출하여 인증 정보를 조회하는 예제입니다.
+
+```ts title="server-side"
+app.use(bodyParser.json());
+// "/certifications"에 대한 POST 요청을 처리하는 controller
+app.post("/certifications", async (request, response) => {
+  const { imp_uid } = request.body; // request의 body에서 imp_uid 추출
+  try {
+    // 인증 토큰 발급 받기
+    const getToken = await axios({
+      url: "https://api.iamport.kr/users/getToken",
+      // POST method
+      method: "post",
+      // "Content-Type": "application/json"
+      headers: { "Content-Type": "application/json" },
+      data: {
+        imp_key: "imp_apikey", // REST API키
+        imp_secret:
+          "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f", // REST API Secret
+      },
+    });
+    const { access_token } = getToken.data.response; // 인증 토큰
+    // imp_uid로 인증 정보 조회
+    const getCertifications = await axios({
+      // imp_uid 전달
+      url: `https://api.iamport.kr/certifications/${imp_uid}`,
+      // GET method
+      method: "get",
+      // 인증 토큰 Authorization header에 추가
+      headers: { Authorization: access_token },
+    });
+    const certificationsInfo = getCertifications.data; // 조회한 인증 정보
+    // ...
+  } catch (e) {
+    console.error(e);
+  }
+});
+```
+
+## **STEP 03.** 인증 정보 활용하기
+
+조회한 인증 정보에서 다음의 고객 정보를 추출하는 서비스 코드 예제입니다.
+
+- `name`: 이름
+- `gender`: 성별
+- `birth`: 생년월일
+- `unique_key`: CI 값과 동일. 온라인 주민번호와 같은 개인고유식별키
+- `unique_in_site`: DI 값과 동일. 상점아이디(사이트)별로 할당되는 식별키
+
+<div class="hint" data-style="info">
+
+위의 정보 외에 휴대폰 번호(**`phone`**) 및 통신사(**`carrier`**) 또는 외국인(**`foreigner`**) 여부는 **개인정보 제공동의 약관을 사이트에 게재**한 후 **<cs@portone.io>로 신청**하여 취득할 수 있습니다. 해당 부분은 당사 계약 이후 다날PG사로 요청 후 승인이 완료되면 이용 가능한 점 참고해 주시기 바랍니다.
+
+**메일 요청 신청 양식**
+
+- 상호명 :
+- 사업자번호 :
+- 본인인증용 다날 상점ID(CPID) :
+- 업종 :
+- 필요사유 :
+- 개인정보취급방침 url : 앱서비스로 URL형태로 전달이 어려우신 경우 '개인정보취급방침' 경로를 캡쳐하여 전달주시기 바랍니다.
+
+**참고 - 포트원 이용 고객사의 개인정보처리방침 적용 예시**
+
+- `(주)마플 : https://marpple.shop/kr/@/privacy`
+- `(주)브레이브모바일 / 숨고 : https://soomgo.com/terms/privacy`
+- `(주)마켓잇 : https://static.marketit.asia/static/privacy-terms.pdf`
+
+</div>
+
+```ts title="Node.js"
+// "/certifications"에 대한 POST 요청을 처리하는 controller
+app.post("/certifications", async (request, response) => {
+  const { imp_uid } = request.body; // request의 body에서 imp_uid 추출
+  try {
+    // 인증 토큰 발급 받기
+    /* ...중략... */
+    // imp_uid로 인증 정보 조회
+    /* ...중략... */
+    const certificationsInfo = getCertifications.data; // 조회한 인증 정보
+    // unique_key: 개인식별 고유 키, unique_in_site: 사이트 별 개인식별 고유 키
+    const { unique_key, unique_in_site, name, gender, birth } =
+      certificationsInfo;
+    // 연령 제한 로직
+    if (new Date(birth).getFullYear() <= 1999) {
+      // 연령 만족
+    } else {
+      // 연령 미달
+    }
+    // 1인 1계정 허용 로직
+    // DB에서 unique_key 조회 후 가입여부 검사
+    Users.find({ certificationKey: unique_key }).then((user) => {
+      if (!user) {
+        // 신규 고객
+      } else {
+        // 이미 가입된 고객
+      }
+    });
+  } catch (e) {
+    console.error(e);
+  }
+});
+```

package/assets/docs/opi/ko/extra/identity-verification/v1/phone/readme.md

@@ -0,0 +1,19 @@
+---
+title: 휴대폰 본인인증 연동하기
+description: 포트원을 이용하여 간편하게 휴대폰 본인인증을 연동하는 방법을 확인합니다.
+targetVersions:
+  - v1
+versionVariants:
+  v2: /opi/ko/extra/identity-verification/readme-v2
+---
+
+**휴대폰 본인인증 서비스**란 본인 명의로 개통한 휴대폰을 이용하여 최소한의 개인정보를 입력하는 인증 절차를 거쳐 본인 여부와 입력한 정보의 정확성을 확인하여 주는 서비스입니다.
+
+고객은 웹사이트에 가입, 결제, 또는 성인 인증 등을 위해 본인인증을 시행합니다.
+본인인증은 모바일 기기에 설치된 본인인증 전용 앱을 이용하거나 사용자 본인 정보(**이름, 생년월일, 휴대폰번호**)를 인증요청 페이지에 입력한 후
+문자로 온 인증번호를 기입하는 방식으로 이루어집니다.
+
+(이미지 첨부: 휴대폰 본인인증 화면예)
+
+포트원을 이용한 휴대폰 본인인증의 Flow는 JavaScript SDK 를 이용하여 휴대폰 본인인증을 완료하고
+고객사 서버에서 포트원 REST API를 이용하여 **인증완료정보를 획득**하는 방법으로 진행됩니다.

package/assets/docs/opi/ko/extra/identity-verification/v1/readme.md

@@ -0,0 +1,9 @@
+---
+title: 본인인증 연동하기
+description: 포트원을 이용하여 간편하게 본인인증을 연동하는 방법을 확인합니다.
+targetVersions:
+  - v1
+versionVariants:
+  v2: /opi/ko/extra/identity-verification/readme-v2
+---
+