{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1fbb2e92-5fd5-4f7d-a3d6-091114c62ed5","name":"1. 모주 API 명세서","description":"> **모의주식 투자 서비스<모주> API 명세서입니다.** \n  \n\n- Base URL(prod) : [https://mozu-prod.xquare.app](https://mozu-prod.xquare.app) \\[❌\\] 현재 미사용\n    \n- **Base URL(stag)** : [https://mozu-stag.xquare.app](https://mozu-stag.xquare.app) \\[✅\\] 현재 사용\n    \n\n---\n\nSTAG 서버 테스트 계정 - 수업(id:7), 종목, 기사 실제 데이터 적용\n\n\\-> 수업 진행 API 연동 시에 해당 테스트 계정 사용\n\n- id : tyler0922\n    \n- pw : 12341234\n    \n\n---\n\n## API URL 목록\n\n기관 API \\[/organ\\]\n\n- \\[POST\\] 기관 로그인 API - {host}/organ/login\n    \n- \\[GET\\] 기관 토큰 재발급 API - {host}/organ/token/re-issue\n    \n- \\[GET\\] 기관 목록 조회 API - {host}/organ\n    \n- \\[GET\\] 기관 상세 조회 API - {host}/organ/:id\n    \n- \\[POST\\] 기관 생성 API - {host}/organ\n    \n\n---\n\n수업 API \\[/class\\]\n\n- \\[GET\\] 수업 목록 조회 API - {host}/class\n    \n- \\[GET\\] 수업 상세 조회 API - {host}/class/:id\n    \n- \\[POST\\] 수업 생성 API - {host}/class\n    \n- \\[POST\\] 수업 수정 API - {host}/class/:id\n    \n- \\[POST\\] 수업 즐겨찾기 변경 API - {host}/class/star/:id\n    \n- \\[DELETE\\] 수업 삭제 API - {host}/class/:id\n    \n\n---\n\n- \\[POST\\] 수업 시작 API - {host}/class/start/:id\n    \n- \\[GET\\] 수업 기관 SSE 연결 API - {host}/class/sse/:id\n    \n- \\[POST\\] 수업 다음 차수 진행 API - {host}/class/next/:id\n    \n- \\[POST\\] 수업 종료 API - {host}/class/stop/:id\n    \n- \\[GET\\] 수업 종목 조회 API - {host}/class/classITem/:id\n    \n- \\[GET\\] 수업 기사 조회 API - {host}/class/classArticle/:id\n    \n- \\[GET\\] \\[학생\\] 수업 차수 종목 목록 조회 API - {host}/class/team/classItem\n    \n- \\[GET\\] \\[학생\\] 수업 종목 상세 조회 API - {host}/class/team/classItem/:id\n    \n- \\[GET\\] \\[학생\\] 수업 차수 기사 목록 조회 API - {host}/class/team/classArticle\n    \n\n---\n\n기사 API \\[/article\\]\n\n- \\[GET\\] 기사 목록 조회 API - {host}/article\n    \n- \\[GET\\] 기사 상세 조회 API - {host}/article/:id\n    \n- \\[POST\\] 기사 생성 API - {host}/article\n    \n- \\[POST\\] 기사 수정 API - {host}/article/:id\n    \n- \\[DELETE\\] 기사 삭제 API - {host}/article/:id\n    \n\n---\n\n종목 API \\[/item\\]\n\n- \\[GET\\] 종목 목록 조회 API - {host}/item\n    \n- \\[GET\\] 종목 상세 조회 API - {host}/item/:id\n    \n- \\[POST\\] 종목 생성 API - {host}/item\n    \n- \\[POST\\] 종목 수정 API - {host}/item/:id\n    \n- \\[DELETE\\] 종목 삭제 API - {host}/item/:id\n    \n\n---\n\n참여 팀 API \\[/team\\]\n\n- \\[POST\\] 참여 팀 수업 참여 API - {host}/team/participate\n    \n- \\[GET\\] 참여 팀 SSE 연결 API - {host}/team/sse\n    \n- \\[POST\\] 참여 팀 투자 완료 API - {host}/team/\bend\n    \n- \\[GET\\] 참여 팀 상세 정보 조회 API - {host}/team\n    \n- \\[GET\\] 참여 팀 보유 주식 조회 API - {host}/team/holdItems\n    \n- \\[GET\\] 참여 팀 거래 내역 조회 API - {host}/team/orders\n    \n- \\[GET\\] 참여 팀 결과 요약 조회 API - {host}/team/result\n    \n- \\[GET\\] 참여 팀 수업 랭킹 조회 API - {host}/team/rank\n    \n- \\[GET\\] \\[기관\\] 참여 팀 거래 현황 조회 API - {host}/team/:id\n    \n\n---\n\n### 수업 진행 API 요청 로직\n\n1. \\[기관 - POST\\] 수업 시작 API\n    \n2. \\[기관 - GET\\] 수업 기관 SSE 연결 API\n    \n3. \\[학생 - POST\\] 참여 팀 수업 참여 API\n    \n    1. SSE -> 기관 : EVENT-1 이벤트 발생, 참여 팀 정보 전달\n        \n4. \\[학생 - GET\\] 참여 팀 SSE 연결 API\n    \n5. \\[기관 - POST\\] 수업 다음 차수 진행 API\n    \n    1. SSE -> 학생 : EVENT-3 이벤트 발생, 수업 다음 차수 정보 전달\n        \n6. \\[학생 - 투자 진행 중 조회 API 목록\\]\n    \n    1. 수업 : 수업 차수 종목 목록 조회 API, 수업 차수 기사 목록 조회 API, 수업 종목 상세 조회 API\n        \n    2. 참여 팀 : 참여 팀 상세 정보 조회 API, 참여 팀 보유 주식 조회 API\n        \n    3. 기사 : 기사 상세 조회 API\n        \n7. \\[기관 - 투자 진행 중 조회 API 목록\\]\n    \n    1. 수업 : 수업 종목 조회 API, 수업 기사 조회 API\n        \n    2. 참여 팀 : 참여 팀 거래 현황 조회 API\n        \n8. \\[학생 - POST\\] 참여 팀 투자 완료 API\n    \n    1. SSE -> 기관 : EVENT-2 이벤트 발생, 수업 차수 참여 팀 투자 결과 정보 전달\n        \n9. \\[학생 - 투자 완료 후 대기 중 조회 API 목록\\]\n    \n    1. 참여 팀 : 참여 팀 거래 내역 조회 API, 참여 팀 결과 요약 조회 API, 참여 팀 수업 랭킹 조회 API\n        \n10. \\[기관 - POST\\] 수업 다음 차수 진행 API\n    \n11. ...반복\n    \n12. \\[기관 - POST\\] 수업 종료 API\n    \n\n---\n\n### SSE 이벤트 목록\n\n- \\[EVENT-1\\] 참여 팀 수업 참가 이벤트 | SSE -> 기관\n    \n\n``` json\nevent: TEAM_PART_IN\ndata: {\"teamId\":1,\"teamName\":\"참여 팀 1번이다 ㅋ\",\"schoolName\":\"대덕소프트웨어마이스터고등학교\"}\n\n ```\n\n- \\[EVENT-2\\] 참여 팀 차수 투자 완료 이벤트 | SSE -> 기관\n    \n\n``` json\nevent: TEAM_INV_END\ndata: {\"teamId\":1,\"teamName\":\"참여 팀 1번이다 ㅋ\",\"invDeg\":1,\"totalMoney\":5056000,\"valMoney\":56000,\"profitNum\":\"1.1199999999999999%\"}\n\n ```\n\n- \\[EVENT-3\\] 수업 다음 차수 진행 이벤트 | SSE -> 학생\n    \n\n``` json\nevent: CLASS_NEXT_INV_START\ndata: {\"classId\":7,\"nextInvDeg\":1}\n\n ```\n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"41266922","team":6767151,"collectionId":"1fbb2e92-5fd5-4f7d-a3d6-091114c62ed5","publishedId":"2sAYX6qhtw","public":true,"publicUrl":"https://documenter-api.postman.tech/view/41266922/2sAYX6qhtw","privateUrl":"https://go.postman.co/documentation/41266922-1fbb2e92-5fd5-4f7d-a3d6-091114c62ed5","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2025-02-17T11:55:52.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"[0-공통] 개발 환경 STAG","id":"27d223a7-0106-4c3d-a6d5-7f6c8fa379db","owner":"41266922","values":[{"key":"host","value":"https://mozu-stag.dsmhs.kr/","enabled":true,"type":"default"},{"key":"accessToken","value":"","enabled":true,"type":"default"},{"key":"refreshToken","value":"","enabled":true,"type":"default"},{"key":"studentToken","value":"","enabled":true,"type":"any"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/1fc3137f35a35fce8174661ed3ecd7d04017467c1166ddacf5cca57fc1d1115a","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"[0-공통] 개발 환경 STAG","value":"41266922-27d223a7-0106-4c3d-a6d5-7f6c8fa379db"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAYX6qhtw"}