역할
공개노트/개발/모듈/SMC 통합운영시스템의 백엔드 API 117개·응답 코드·테이블 목록을 찾아보는 페이지임. 화면과 기능 설명은 본 페이지가 아니라 위 페이지에 있음.
- 모든 API 응답은
{resCd, resMsg, resData, totCnt}형태임(SFWResponseDto) - 프론트는
resCd !== "SQI0000"이면resMsg를 그대로 팝업에 띄움. 운영팀이 캡처해 오는 오류 문구가 곧resMsg임 - 메시지의
[{1}]은 예외 메시지를&(SQI_FRAMEWORK_EXCEPTION_DELIMETER)로 잘라 채움. 필수 입력 체크 구분자는;(NCSS_CHECK_DELIMETER)
API 응답 코드
근거: backend/.../comn/enums/ApiResponseCode.java
| 코드 | 메시지 | 언제 |
|---|---|---|
| SQI0000 | 성공 | 정상 |
| SQI0001 | 실패 | 일반 실패 |
| SQI0002 | 데이터가 없습니다. | 조회 결과 0건 |
| SQI0003 | 중복된 데이터가 존재합니다. | 차단IP·계정 중복 등록 |
| SQI0004 | 수정 요청 대상 데이터가 존재하지 않습니다. | 승인 대상 불일치 포함 |
| SQI0005 | 삭제 요청 대상 데이터가 존재하지 않습니다. | 선택 건수 ≠ 조회 건수 |
| SQI0006 | [{1}] 등록중 오류가 발생하였습니다. | 등록 실패 |
| SQI0007 | [{1}] 수정중 오류가 발생하였습니다. | 수정 실패 |
| SQI0008 | [{1}] 삭제중 오류가 발생하였습니다. | 삭제 실패 |
| SQI0009 | [{1}]값이 비어있습니다. | 값 누락 |
| SQI0010 | 사용자 정보가 존재 하지 않습니다. | 로그인 시 계정 없음 / 역할 불일치 |
| SQI0011 | 신규 입력 비밀번호와 비밀번호 확인값이 일치하지 않습니다. | 비밀번호 재설정 |
| SQI1000 | 사용자 아이디 또는 비밀번호가 잘못 입력되었습니다. | 로그인·비밀번호 변경 |
| SQI1001 | [{1}] 요청에 대한 권한이 없습니다. | 권한 부족 |
| SQI1002 | 비밀번호가 만료 되었습니다. | 만료일 경과 |
| SQI1003 | 사용자의 계정이 승인대기 상태 입니다. 관리자에게 문의하세요. | RDY |
| SQI1004 | 연속5회 비밀번호 오류로 사용자의 계정이 잠김 상태 입니다. 비밀번호 재 설정후 로그인 하세요. | LCK |
| SQI1005 | 사용자의 계정이 승인거부 상태 입니다. 관리자에게 문의하세요. | DEN |
| SQI1006 | 사용자의 계정이 중지 상태 입니다 관리자에게 문의하세요. | STP |
| SQI1009 | SMS 발송 중 오류 발생. | SMS 발송 실패 전반 |
| SQI1010 | 사용할 수 없는 계정이거나 SMS 인증이 완료되지 않았습니다. | 인증번호 불일치 |
| SQI1011 | [{1}] 중 오류가 발생하였습니다. | 로그인 처리 중 예외 |
| SQI1013 | 사용자를 찾을 수 없습니다. | SMS 인증 시 계정 없음 |
| SQI1014 | 사용자 전화번호가 일치하지 않습니다. | SMS 인증 시 |
| SQI1015 | PUSH된 공지사항은 수정할 수 없습니다. | enum 코드값이 SQI1014로 잘못 들어감 |
| SQI2000 | Access token이 누락되었습니다. | 토큰 없음 |
| SQI2001 | Access token이 만료되었습니다. | 10분 경과 |
| SQI2002 | Access token의 형식이 잘못되었습니다. | 토큰 형식 오류 |
| SQI2010 | Refresh token이 누락되었습니다. | 토큰 없음 |
| SQI2011 | Refresh token이 만료되었습니다. | 프론트가 강제 로그아웃 |
| SQI2012 | Refresh token이 잘못되었습니다. | 토큰 불일치 |
| SQI3000 | 인증 정보가 부족하여 요청이 거부 되었습니다.[로그인 필요] | HTTP 401 |
| SQI3001 | 해당 요청에 대한 권한이 없습니다. | HTTP 403 / 차단IP |
| SQI4000 | 실행파일(.exe, .bat, .com, .dll), 스크립트파일은 등록하실 수 없습니다. | 업로드 차단(Tika 판별) |
| SQI7200 | 하위 메뉴가 존재 하는 메뉴는 메뉴 기능을 등록할수 없습니다.[{1}] | 메뉴 권한 저장 |
| SQI8000 | 필수 입력 파라미터 [{1}] 값이 누락되었습니다. | 필수값 누락 |
| SQI9000 | 요청 처리중 DB 오류 발생 | MyBatis DataAccessException |
| SQI9001 | API 호출 URL 정보가 올바르지 않습니다. | 핸들러 없음 / 잘못된 path 변수 |
| SQI9002 | 예상하지 못한 오류가 발생하였습니다. 관리자에게 문의하세요. | 미분류 예외 |
| SQI9003 | API 호출 정보가 올바르지 않습니다. | 잘못된 호출 |
프론트 전용 문구 (서버 코드 아님)
에러가 발생하였습니다.</br>다시 시도해주십시오., 로그인 정보가 없습니다., 다시 로그인을 해주시기 바랍니다., 로그인 후 이용해주세요., 저장되었습니다., 저장에 실패했습니다., 저장하시겠습니까?, 일정시간 미사용으로 접속이 종료되었습니다.</br>다시 로그인해 주십시오., 회원님의 아이디는 이미 로그인 중입니다., 잘못된 주소를 호출하였습니다., 페이지를 찾을 수 없습니다.
백엔드 API 117개
모든 경로 앞에 /api/v1이 붙음.
| 컨트롤러 | 기본 경로 | 엔드포인트 |
|---|---|---|
인증 CertController | /cert | POST /join, POST /login, PUT /resetPassword, PUT /change-password, PUT /unsetPassword, POST /certSms, POST /checkSms |
토큰 MngrTokenController | /token | POST /refresh, POST /update, DELETE /delete |
관리자 ManagerController | /mngr | GET /managers, POST /managers/{mngrId}, POST /managers, PUT /managers, DELETE /managers, PUT /managers-lock, PUT /managers-approve, PUT /password-expiration-extension, GET /myinfo, PUT /myinfo, GET /checkauth |
앱 사용자 AppUserController | /mngr | GET /appusers, GET /appusers/{usrId}, PUT /appusers |
공통 MngrComnController | /mngr | GET /comn/codes/{cdGrpId}, GET /comn/navmenu, GET /comn/grp-codes, GET /comn/ara-codes, GET /comn/sbd-codes, GET /comn/smah-sbd-codes, GET /comn/frm-codes, GET /comn/hnet-codes, GET /comn/role-codes[/{rolDesc}] |
코드 MngrCodeController | /mngr | GET /grpcodes, GET /grpcodes/{cdGrpId}, GET /dtlcodes, GET /dtlcodes/{cdGrpId}/{cdDtlId} |
게시판 CommonBoardController | /mngr/boards | GET /{natTpCd}, GET /{natTpCd}/{natSn}, POST /{natTpCd}, PUT /{natTpCd}, DELETE /{natTpCd}, GET /attach-file/{ahflSn}, DELETE /attach-file |
공지 CommonNoticeController | /mngr/boards | GET /common-notice (나머지 주석 처리) |
약관 CommonTermsController | /mngr/boards | GET /terms/{cluTpCd}, GET /terms/{cluTpCd}/{svcCluSn}, POST /terms/{cluTpCd}, PUT /terms/{cluTpCd}, DELETE /terms/{cluTpCd} |
입주자 공지 RsdAnncController | /mngr/rsd-annc | GET, GET /{anncFtcsSn}, POST, PUT, DELETE, DELETE /attach-file |
로그 SysConnLogController | /mngr | POST /scl, GET /log/sys-conn-log |
배치 BatchLogController | /mngr | GET /log/batchs, GET /log/batchs/{procNm}, GET /log/batch-logs |
운영보고서 CloudOprController | /mngr/report | GET /cloud-operation, GET /cloud-operation/{stndYm}, POST /cloud-operation, PUT /cloud-operation, DELETE /cloud-operation, GET /cloud-operation/attach-file/{stndYm} |
리포트 ReportController | /report | GET /inif-trt |
홈넷사 HomenetController | /sysmngr | GET /hnets, GET /hnets/{hnetFrmSn}, POST /hnets, PUT /hnets, DELETE /hnets, GET /hnets-key |
연동시스템 LinkSystemController | /sysmngr | GET /linkSystem, GET /linkSystem/{hnetFrmSn} |
차단IP IpManagerController | /sysmngr/security | GET /block-ip, GET /block-ip/{ip}, POST /block-ip, PUT /block-ip, DELETE /block-ip |
시스템메뉴 SysMenuController | /sysmngr | GET /menus, GET /menus/{mnuId}, PUT /menus |
역할 UserRoleController | /sysmngr | GET /roles, GET /roles/{rolId}, POST /roles, PUT /roles, DELETE /roles |
메뉴권한 MenuRoleController | /sysmngr | GET /menuroles/{rolId}, GET /menuroles/{rolId}/{mnuId}, PUT /menuroles |
프레임워크 잔재 (프론트 미사용)
| 컨트롤러 | 기본 경로 | 엔드포인트 |
|---|---|---|
ApiComnController | /apicomn | GET /findNavMenuList, /findAllCodeGroupList, /findAllCodeDetailListByCodeGroup, /findMenuListByCondition, /findRoleListByCondition |
CodeController | /code | GET /findCodeGroupList, /findCodeGroupDetailInfo, POST inputCode, PUT modifyCode, DELETE deleteCode |
MenuController | /menu | GET /findMenuList, /findMenuDetailInfo, POST /inputMenu, PUT /modifyMenu, DELETE /deleteMenu |
RolenAuthController | /rolenauth | GET /findRolenAuthList, /findRolenAuthDetailInfo, POST /inputRolenAuth |
UserController | /user | GET /findUserList, /findUserDetailInfo, POST /inputUser, PUT /modifyUser, DELETE /deleteUser, PUT /extendUserPasswordExpireDate |
| 빈 껍데기 | /widearea, /lhc | WideareaController, LhcController — 클래스 매핑만 있고 메서드 없음. RefreshTokenController는 전체 주석 처리 |
- 프론트가 호출하는데 백엔드에 대응 엔드포인트가 없는 것:
POST list(관리자·사용자·홈넷사 목록의 더미 호출fetchUsConnColumns,fetchUsrColumns,fetchOtherSysList등),POST /(대시보드fetchDashboard). 호출해도 의미 없음
데이터
주요 테이블
| 스키마.테이블 | 용도 |
|---|---|
cmn.tb_mngr_m | 관리자 계정(비밀번호 해시, 상태, 실패횟수, 만료일, 암호화 연락처, SMS 인증번호) |
cmn.tb_mngr_refsh_tkn_m | 관리자 리프레시 토큰 |
cmn.tb_mngr_lgn_l | 관리자 로그인 이력 |
cmn.tb_sys_conn_l | 시스템(메뉴) 접속 이력 |
cmn.tb_usr_m | 앱 사용자 |
cmn.tb_rol_m | 역할 |
cmn.tb_mnu_m | 메뉴 |
cmn.tb_rol_mnu_r | 역할-메뉴-기능(C/R/U/D) 매핑 |
cmn.tb_cd_grp_m / cmn.tb_cd_dtl_m | 공통코드 그룹 / 상세 |
cmn.tb_cstt_m | 시스템 상수(내부 API 주소·키 등) |
cmn.tb_grp_m / cmn.tb_grp_sbd_r | 지역그룹 / 지역-단지 관계 |
cmn.tb_sbd_m | 단지 마스터 |
cmn.tb_smah_sbd_d | 스마트홈 대상 단지 |
cmn.tb_frm_m | 업체(홈넷사 포함). 연동URL·연동키·OAuth 정보 보유 |
cmn.tb_conn_shto_ipad_m | 접속 차단 IP |
cmn.tb_nat_m / cmn.tb_nat_ahfl_r | 게시글(공지/FAQ/자료실) / 첨부 관계 |
cmn.tb_ahfl_m | 첨부파일 메타 |
cmn.tb_rsd_annc_fcts_l | 입주자 공지사항 |
cmn.tb_svc_clu_m | 서비스 약관 |
cmn.tb_proc_m / cmn.tb_proc_run_h | 배치 정의 / 실행 이력 |
cmn.tb_cld_opr_rpt_l | 클라우드 운영보고서 |
cmn.tb_inif_trt_l | 개인정보 취급 내역 |
alog.tb_cld_lnkg_api_req_l / alog.tb_cld_lnkg_api_rsp_l | 클라우드 연동 API 요청 / 응답 로그 |
MyBatis 매퍼 XML 위치: backend/src/main/resources/mapper-rdb/ (apicomn, code, menu, RolenAuth, user, mngrcomn(14개), sysmngr(6개)).
상태 코드
| 구분 | 값 | 뜻 |
|---|---|---|
관리자 상태 mngr_ss_cd | RDY | 승인대기(신규 등록 기본값) |
USE | 정상 사용(승인됨) | |
LCK | 잠김(비밀번호 5회 연속 오류) | |
DEN | 승인거부 | |
STP | 중지 | |
PRE | 최초 가입 전 단계 | |
JIN | SMS 인증 완료(가입 진행) | |
INI | 초기 상태(코드상 등장) | |
업체 유형 frm_ty_cd | J | 홈넷사 |
연동 응답 hnet_api_rsp_cd(ONL_DS_CD) | 00 | 정상(초록) |
01 | 오류(빨강) | |
null | 호출 이력 없음(회색) | |
메뉴 기능 mnu_fnc_cd | C/R/U/D | 등록/조회/수정/삭제 → POST/GET/PUT/DELETE |
A | 1차 메뉴 접근(화면 체크박스 전용) | |
게시판 유형 EnumNatTp | ANN/FAQ/ARC/QNA/NOTICE/CLOUDOPR/UNKNOWN | 시스템공지/FAQ/자료실/QNA 등 |
약관 유형 EnumCluTp | SVC/IPA/OSS | 서비스이용약관/정보제공동의서/오픈소스 라이선스 |
공지 프로그램 구분 pgmDsCd | APP/LHW/SYS | 앱/관리자웹/시스템 |
| 사용 여부 | Y/N | 사용/사용안함 |
메일 수신여부 emlRcvYn | Y/N | 수신/수신 안함 |
그 밖에 화면에서 쓰는 공통코드 그룹: FRM_TY_CD(업체타입), POD_CD(배치 주기), RUN_TY_CD(실행유형), RSL_CD(실행결과), NAT_TP_CD·NAT_DTL_TP_CD(게시판 유형·상세유형), ANNC_FCTS_DS_CD·ANNC_TRG_MCH_CD(입주자 공지 구분·대상), USR_SS_CD(사용자 상태), MNGR_SS_CD(관리자 상태), ONL_DS_CD(연동 상태).
관련
공개노트/개발/모듈/SMC 통합운영시스템 공개노트/개발/시스템 구성 공개노트/개발/인터페이스 정의 공개노트/개발/모듈/APW 연계 서버 공개노트/개발/모듈/SMS 발송