feat: add messaging transport rollout

2026-06-06 00:02:52 +09:00
parent 4b91343ee8
commit 6c7a1cf6f6
383 changed files with 99045 additions and 487 deletions
@@ -0,0 +1,64 @@
+# 접근토큰폐기(P)
+
+- 원본 시트명: 접근토큰폐기(P)
+- API 통신방식: REST
+- 메뉴 위치: OAuth인증
+- API ID: 인증-002
+- HTTP Method: POST
+- 실전 TR_ID: 없음
+- 모의 TR_ID: 없음
+- 실전 Domain: https://openapi.koreainvestment.com:9443
+- 모의 Domain: https://openapivts.koreainvestment.com:29443
+- URL 명: /oauth2/revokeP
+- 모의투자 지원: 지원
+- 원본 워크북: [한국투자증권_오픈API_전체문서_20260430_030000.xlsx](../../../../한국투자증권_오픈API_전체문서_20260430_030000.xlsx)
+
+## 개요
+
+부여받은 접큰토큰을 더 이상 활용하지 않을 때 사용합니다.
+
+## 레이아웃
+
+### Request Header
+
+없음
+
+### Request Body
+
+| Element | 한글명 | Type | Required | Length | Description |
+| --- | --- | --- | --- | --- | --- |
+| appkey | 고객 앱Key | string | Y | 36 | 한국투자증권 홈페이지에서 발급받은 appkey (절대 노출되지 않도록 주의해주세요.) |
+| appsecret | 고객 앱Secret | string | Y | 180 | 한국투자증권 홈페이지에서 발급받은 appsecret (절대 노출되지 않도록 주의해주세요.) |
+| token | 접근토큰 | string | Y | 286 | OAuth 토큰이 필요한 API 경우 발급한 Access token<br>일반고객(Access token 유효기간 1일, OAuth 2.0의 Client Credentials Grant 절차를 준용)<br>법인(Access token 유효기간 3개월, Refresh token 유효기간 1년, OAuth 2.0의 Authorization Code Grant 절차를 준용) |
+
+### Response Header
+
+없음
+
+### Response Body
+
+| Element | 한글명 | Type | Required | Length | Description |
+| --- | --- | --- | --- | --- | --- |
+| code | 응답코드 | string | N | 8 | HTTP 응답코드 |
+| message | 응답메세지 | string | N | 450 | 응답메세지 |
+
+## 예제
+
+### Request Example (Python)
+
+```text
+{
+  "appkey" : "PSw2UvBQCpoZFc7nZpIfIrOttmXXXXXXXXXX",
+  "appsecret" : "/g84gaZp7W3DJEZhamiTH8ZdJkUJ8603rjo3HcOm5PvIc1YC3YmyJOQoW1H0kNjo4IbHwGUdi3+9oEbH4RKKl8GnEu3n/khxm0OrwHkQur+wbA74fcFXxaUnEbftu0X72Eaw9dEBMuK3rODeeOanrsJ1kZ9oKWykIG04F0nmgdXXXXXXXXXX",
+  "token" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0b2tlbiIsImF1ZCI6IjZmNDgxMjBiLTlmMDItNGI5ZS05MGExLTRiNDk2MGM5ZWY2MyIsImlzcyI6InVub2d3IiwiZXhwIjoxNjQzMjg2MDUzLCJpYXQiOjE2NDMxOTk2NTMsImp0aSI6IlBTdzJVdkJRQ3dvWkZhOG5acElmSXJPdHRtZUtLUGZCclNKcyJ9.6Z-UvArobBfXbnpSFbFhd9WPVEM3ZQa5NEpqfmQ6rrZBISCi-P9CEamfVReIduTVYbafF02Pl6EPXXXXXXXXXX"
+}
+```
+
+### Response Example
+
+```text
+{
+  "code" : 200,
+  "message" : "접근토큰 폐기에 성공하였습니다"
+}
+```
@@ -0,0 +1,82 @@
+# 접근토큰발급(P)
+
+- 원본 시트명: 접근토큰발급(P)
+- API 통신방식: REST
+- 메뉴 위치: OAuth인증
+- API ID: 인증-001
+- HTTP Method: POST
+- 실전 TR_ID: 없음
+- 모의 TR_ID: 없음
+- 실전 Domain: https://openapi.koreainvestment.com:9443
+- 모의 Domain: https://openapivts.koreainvestment.com:29443
+- URL 명: /oauth2/tokenP
+- 모의투자 지원: 지원
+- 원본 워크북: [한국투자증권_오픈API_전체문서_20260430_030000.xlsx](../../../../한국투자증권_오픈API_전체문서_20260430_030000.xlsx)
+
+## 개요
+
+본인 계좌에 필요한 인증 절차로, 인증을 통해 접근 토큰을 부여받아 오픈API 활용이 가능합니다.
+
+1. 접근토큰(access_token)의 유효기간은 24시간 이며(1일 1회발급 원칙) 
+   갱신발급주기는 6시간 입니다.(6시간 이내는 기존 발급키로 응답)
+
+2. 접근토큰발급(/oauth2/tokenP) 시 접근토큰값(access_token)과 함께 수신되는 
+   접근토큰 유효기간(acess_token_token_expired)을 이용해 접근토큰을 관리하실 수 있습니다.
+
+
+[참고]
+
+'23.4.28 이후 지나치게 잦은 토큰 발급 요청건을 제어 하기 위해 신규 접근토큰발급 이후 일정시간 이내에 재호출 시에는 직전 토큰값을 리턴하게 되었습니다. 일정시간 이후 접근토큰발급 API 호출 시에는 신규 토큰값을 리턴합니다. 
+접근토큰발급 API 호출 및 코드 작성하실 때 해당 사항을 참고하시길 바랍니다.
+
+※ 참고 : 포럼 &gt; 공지사항 &gt;  [수정] [중요] 접근 토큰 발급 변경 안내
+
+## 레이아웃
+
+### Request Header
+
+없음
+
+### Request Body
+
+| Element | 한글명 | Type | Required | Length | Description |
+| --- | --- | --- | --- | --- | --- |
+| grant_type | 권한부여 Type | string | Y | 18 | client_credentials |
+| appkey | 앱키 | string | Y | 36 | 한국투자증권 홈페이지에서 발급받은 appkey (절대 노출되지 않도록 주의해주세요.) |
+| appsecret | 앱시크릿키 | string | Y | 180 | 한국투자증권 홈페이지에서 발급받은 appsecret (절대 노출되지 않도록 주의해주세요.) |
+
+### Response Header
+
+없음
+
+### Response Body
+
+| Element | 한글명 | Type | Required | Length | Description |
+| --- | --- | --- | --- | --- | --- |
+| access_token | 접근토큰 | string | Y | 350 | OAuth 토큰이 필요한 API 경우 발급한 Access token<br>ex) "eyJ0eXUxMiJ9.eyJz…..................................."<br><br> - 일반개인고객/일반법인고객<br>  . Access token 유효기간 1일<br>  .. 일정시간(6시간) 이내에 재호출 시에는 직전 토큰값을 리턴<br>  . OAuth 2.0의 Client Credentials Grant 절차를 준용<br><br> - 제휴법인<br>  . Access token 유효기간 3개월<br>  . Refresh token 유효기간 1년<br>  . OAuth 2.0의 Authorization Code Grant 절차를 준용 |
+| token_type | 접근토큰유형 | string | Y | 20 | 접근토큰유형 : "Bearer"<br>※ API 호출 시, 접근토큰유형 "Bearer" 입력. ex) "Bearer eyJ...." |
+| expires_in | 접근토큰 유효기간 | number | Y | 10 | 유효기간(초)<br>ex) 7776000 |
+| access_token_token_expired | 접근토큰 유효기간(일시표시) | string | Y | 50 | 유효기간(년:월:일 시:분:초)<br>ex) "2022-08-30 08:10:10" |
+
+## 예제
+
+### Request Example (Python)
+
+```text
+{
+  "grant_type": "client_credentials",
+  "appkey": "PSg5dctL9dKPo727J13Ur405OSXXXXXXXXXX",
+  "appsecret":  "yo2t8zS68zpdjGuWvFyM9VikjXE0i0CbgPEamnqPA00G0bIfrdfQb2RUD1xP7SqatQXr1cD1fGUNsb78MMXoq6o4lAYt9YTtHAjbMoFy+c72kbq5owQY1Pvp39/x6ejpJlXCj7gE3yVOB/h25Hvl+URmYeBTfrQeOqIAOYc/OIXXXXXXXXXX"
+}
+```
+
+### Response Example
+
+```text
+{
+	"access_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0b2tlbiIsImF1ZCI6ImMwNzM1NTYzLTA1MjctNDNhZS05ODRiLTJiNWI1ZWZmOWYyMyIsImlzcyI6InVub2d3IiwiZXhwIjoxNjQ5NzUxMTAwLCJpYXQiOjE2NDE5NzUxMDAsImp0aSI6IkJTZlM0QUtSSnpRVGpmdHRtdXZlenVQUTlKajc3cHZGdjBZVyJ9.Oyt_C639yUjWmRhymlszgt6jDo8fvIKkkxH1mMngunV1T15SCC4I3Xe6MXxcY23DXunzBfR1uI0KXXXXXXXXXX",
+	"access_token_token_expired":"2023-12-22 08:16:59",
+	"token_type":"Bearer",
+	"expires_in":86400
+}
+```