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,67 @@
+# 실시간 (웹소켓) 접속키 발급
+
+- 원본 시트명: 실시간 (웹소켓) 접속키 발급
+- API 통신방식: WEBSOCKET
+- 메뉴 위치: OAuth인증
+- API ID: 실시간-000
+- HTTP Method: POST
+- 실전 TR_ID: 없음
+- 모의 TR_ID: 없음
+- 실전 Domain: https://openapi.koreainvestment.com:9443
+- 모의 Domain: https://openapivts.koreainvestment.com:29443
+- URL 명: /oauth2/Approval
+- 모의투자 지원: 지원
+- 원본 워크북: [한국투자증권_오픈API_전체문서_20260430_030000.xlsx](../../../../한국투자증권_오픈API_전체문서_20260430_030000.xlsx)
+
+## 개요
+
+실시간 (웹소켓) 접속키 발급받으실 수 있는 API 입니다.
+웹소켓 이용 시 해당 키를 appkey와 appsecret 대신 헤더에 넣어 API를 호출합니다.
+
+접속키의 유효기간은 24시간이지만, 접속키는 세션 연결 시 초기 1회만 사용하기 때문에 접속키 인증 후에는 세션종료되지 않는 이상 접속키 신규 발급받지 않으셔도 365일 내내 웹소켓 데이터 수신하실 수 있습니다.
+
+## 레이아웃
+
+### Request Header
+
+| Element | 한글명 | Type | Required | Length | Description |
+| --- | --- | --- | --- | --- | --- |
+| content-type | 컨텐츠타입 | string | N | 20 | application/json; utf-8 |
+
+### Request Body
+
+| Element | 한글명 | Type | Required | Length | Description |
+| --- | --- | --- | --- | --- | --- |
+| grant_type | 권한부여타입 | string | Y | 18 | "client_credentials" |
+| appkey | 앱키 | string | Y | 36 | 한국투자증권 홈페이지에서 발급받은 appkey (절대 노출되지 않도록 주의해주세요.) |
+| secretkey | 시크릿키 | string | Y | 180 | 한국투자증권 홈페이지에서 발급받은 appsecret (절대 노출되지 않도록 주의해주세요.)<br>* 주의 : appsecret와 secretkey는 동일하오니 착오없으시기 바랍니다. (용어가 다른점 양해 부탁드립니다.) |
+
+### Response Header
+
+없음
+
+### Response Body
+
+| Element | 한글명 | Type | Required | Length | Description |
+| --- | --- | --- | --- | --- | --- |
+| approval_key | 웹소켓 접속키 | string | Y | 286 | 웹소켓 이용 시 발급받은 웹소켓 접속키를 appkey와 appsecret 대신 헤더에 넣어 API 호출합니다. |
+
+## 예제
+
+### Request Example (Python)
+
+```text
+{
+	"grant_type": "client_credentials",
+	"appkey": "PSg5dctL9dKPo727J13Ur405OSXXXXXXXXXX",
+	"secretkey": "yo2t8zS68zpdjGuWvFyM9VikjXE0i0CbgPEamnqPA00G0bIfrdfQb2RUD1xP7SqatQXr1cD1fGUNsb78MMXoq6o4lAYt9YTtHAjbMoFy+c72kbq5owQY1Pvp39/x6ejpJlXCj7gE3yVOB/h25Hvl+URmYeBTfrQeOqIAOYc/OIXXXXXXXXXX"
+}
+```
+
+### Response Example
+
+```text
+{
+    "approval_key": "a2585daf-8c09-4587-9fce-8ab893XXXXX"
+}
+```