> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api-guide/back-office/system-bo/undefined-5.md).

# 메뉴 관리

메뉴 관리 서비스는 관리자 시스템 내 모든 메뉴 및 해당 메뉴의 하위 메뉴 및 권한 메뉴를 효율적으로 관리하는 기능을 제공합니다. 사용자는 새로운 권한 메뉴를 등록하거나 권한 메뉴의 사용 여부를 수정할 수 있습니다.

***

## 주요 기능

* **메뉴 정보 관리**
  * 관리자 시스템의 모든 메뉴 정보와 권한을 체계적으로 관리합니다.
  * 사용자는 하위 메뉴를 등록하면서 버튼, request 등에 대한 권한 메뉴를 부여하고 사용 여부를 수정할 수 있습니다.
  * 메뉴는 BO(Back Office), PO(Partner Office), CC(Customer Center)로 구분되어 조회 가능하며 사용 여부에 따라 검색이 가능합니다.
* **Admin Main 메뉴**
  * 사용자가 관리자 페이지에 접속하면 상단 메뉴와 해당 메뉴의 하위 메뉴를 좌측 메뉴로 조회할 수 있습니다.
  * 사용자는 특정 메뉴를 즐겨찾기에 등록하여 자주 사용하는 메뉴를 편리하게 관리할 수 있습니다.
* **공통 메뉴**
  * 사용자가 화면에 접근할 때 해당 URL에 대한 권한 여부를 확인하고, 개인정보를 포함하는 경우에 대한 접근 여부를 조회합니다.
  * 사용자의 사용 로그를 등록하여 접근 이력을 관리합니다.

***

## 프로세스 정의\_메뉴 정보 관리

관리자 시스템 내 메뉴 및 권한을 관리합니다.

<figure><img src="/files/5k6YVhOQE019IHl6SHqR" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### 메뉴 트리 목록 조회

등록된 전체 메뉴를 트리 구조로 조회합니다. 조회한 후 가장 첫번째 값으로 상세정보, 하위메뉴 정보를 조회합니다.
{% endstep %}

{% step %}

### 메뉴 상세정보 등록/수정

선택한 메뉴에 대한 상세 정보를 등록, 수정할 수 있습니다.
{% endstep %}

{% step %}

### 하위 메뉴 저장

선택한 메뉴에 대한 하위 메뉴를 등록, 수정, 삭제합니다.

* 메뉴 삭제 시 선택한 메뉴에 하위 메뉴가 존재하는지, 해당 메뉴에 유효한 권한 대상이 존재하는지 체크해 존재한다면 삭제처리를 할 수 없습니다.
* 하위 메뉴에 대한 사용여부를 수정합니다.
  {% endstep %}

{% step %}

### 메뉴권한 사용여부 수정

선택한 메뉴에 대한 사용여부를 수정합니다.
{% endstep %}
{% endstepper %}

***

## 프로세스 정의\_공통 및 Admin 메인 관리

관리자 시스템 로그인을 통한 주요 공통 및 Admin 메인을 관리합니다.

<figure><img src="/files/UqIEFX7RI6My4kI7lPJu" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### 상단 메뉴 조회

관리자 시스템 로그인 시 등록된 메뉴들을 조회합니다.

* 상단 메뉴를 조회한 후, 자동으로 첫번째 상단 메뉴에 대한 하위 화면 메뉴를 조회합니다.
* 로그인 한 사용자의 즐겨찾기 메뉴를 조회합니다.
  {% endstep %}

{% step %}

### 즐겨찾기 메뉴 중복체크/등

사용자는 원하는 메뉴를 즐겨찾기 등록합니다. 등록 시 기등록된 메뉴인지 체크합니다.
{% endstep %}

{% step %}

### URL 권한 조회

사용자가 화면에 진입하면 화면 url을 통해 사용 권한을 체크합니다.

* 개인정보를 포함한 화면인지 체크합니다.
* 화면 url 에 대한 사용로그를 저장합니다.
  {% endstep %}
  {% endstepper %}

***

## API 기능 목록\_Admin 메인

<table><thead><tr><th width="107.888916015625">API</th><th width="332.2222900390625">설명</th><th width="92.4444580078125" align="center">Server</th><th width="89.111083984375" align="center">메소드</th><th>비고</th></tr></thead><tbody><tr><td>상단 메뉴 조회</td><td>관리자 시스템의 상단 메뉴를 조회합니다.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=ADMIN%20%EB%A9%94%EC%9D%B8&#x26;path=getTopMenuList">🔗API 확인하기 ></a></td></tr><tr><td>좌측 메뉴 조회</td><td>관리자 시스템의 좌측 메뉴를 조회합니다.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=ADMIN%20%EB%A9%94%EC%9D%B8&#x26;path=getLeftMenuList">🔗API 확인하기 ></a></td></tr><tr><td>즐겨찾기 조회</td><td>관리자 시스템 사용자의 즐겨찾기 목록을 조회합니다.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=ADMIN%20%EB%A9%94%EC%9D%B8&#x26;path=getFavoriteMenu">🔗API 확인하기 ></a></td></tr><tr><td>즐겨찾기 메뉴 등록</td><td>관리자 시스템 사용자의 즐겨찾기 메뉴를 등록합니다.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=ADMIN%20%EB%A9%94%EC%9D%B8&#x26;path=registUserFavoriteMenu">🔗API 확인하기 ></a></td></tr><tr><td>즐겨찾기 메뉴 중복체크</td><td>즐겨찾기 메뉴 등록 시 기등록된 메뉴인지 체크합니다.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=ADMIN%20%EB%A9%94%EC%9D%B8&#x26;path=checkDuplicateUserFavoriteMenu">🔗API 확인하기 ></a></td></tr></tbody></table>

***

## API 기능 목록\_공통

<table><thead><tr><th width="143.4444580078125">API</th><th width="303.2222900390625">설명</th><th width="94.6666259765625" align="center">Server</th><th width="89.111083984375" align="center">메소드</th><th>비고</th></tr></thead><tbody><tr><td>URL 권한 조회</td><td>화면 url에 대한 권한을 조회합니다.</td><td align="center">BO</td><td align="center">POST</td><td><a href="http://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B3%B5%ED%86%B5&#x26;path=getAdminGroups">🔗API 확인하기 ></a></td></tr><tr><td>접속한 URL의 권한 정보 및 <br>개인정보 유무 조회</td><td>접속 url에 대한 권한 정보와 개인정보 유무를 조회합니다.</td><td align="center">BO</td><td align="center">GET</td><td><a href="http://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B3%B5%ED%86%B5&#x26;path=getRtTgtSeqByStRtTgtBase">🔗API 확인하기 ></a></td></tr><tr><td>권한대상 <br>사용로그 등록</td><td>접속한 화면 url에 대한 권한대상 사용로그를 등록합니다.</td><td align="center">BO</td><td align="center">POST</td><td><a href="http://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B3%B5%ED%86%B5&#x26;path=insertStRtTgtBaseLog">🔗API 확인하기 ></a></td></tr></tbody></table>

***

## API 기능 목록\_메뉴 정보 관리

<table><thead><tr><th width="111.2222900390625">API</th><th width="381.2222900390625">설명</th><th width="94.6666259765625" align="center">Server</th><th width="90.22216796875" align="center">메소드</th><th>비고</th></tr></thead><tbody><tr><td>메뉴 트리 목록 조회</td><td>관리자 시스템의 전체 메뉴를 트리 구조 목록으로 조회합니다.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getMenuMgmtTreeList">🔗API 확인하기 ></a></td></tr><tr><td>메뉴 상세 정보 조회</td><td>트리 구조 목록에서 선택한 메뉴에 대한 상세 정보를 조회합니다.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getMenuInfo">🔗API 확인하기 ></a></td></tr><tr><td>하위 메뉴 목록 건수 조회</td><td>트리 구조 목록에서 선택한 메뉴에 대한 하위메뉴 목록 건수를 조회합니다.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getSubMenuListCount">🔗API 확인하기 ></a></td></tr><tr><td>하위 메뉴 목록 조회</td><td>트리 구조 목록에서 선택한 메뉴에 대한 하위메뉴 목록을 조회합니다.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getSubMenuList">🔗API 확인하기 ></a></td></tr><tr><td>메뉴 <br>상세정보 <br>등록</td><td>상위 메뉴에 대한 상세정보를 등록합니다.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=registMenuInfo">🔗API 확인하기 ></a></td></tr><tr><td>메뉴 <br>상세정보 <br>수정</td><td>상위 메뉴에 대한 상세정보를 수정합니다.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=modifyMenuInfo">🔗API 확인하기 ></a></td></tr><tr><td>하위메뉴 <br>존재여부 <br>체크</td><td>메뉴를 삭제할 시 하위메뉴가 존재하는 지 체크합니다.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getSubMenuCheck">🔗API 확인하기 ></a></td></tr><tr><td>유효한 권한대상 체크</td><td>메뉴를 삭제할 시 해당 메뉴에 유효한 권한대상이 있는지 체크합니다.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getRtInfoCheck">🔗API 확인하기 ></a></td></tr><tr><td>하위 메뉴 저장</td><td>하위 메뉴를 저장합니다.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=saveSubMenu">🔗API 확인하기 ></a></td></tr><tr><td>메뉴권한 <br>사용여부 <br>수정</td><td>상위 메뉴에 대한 사용여부를 수정합니다.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=modifyMenuRight">🔗API 확인하기 ></a></td></tr><tr><td>개별권한 <br>사용여부 <br>수정</td><td>하위 메뉴에 대한 사용여부를 수정합니다.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EB%A9%94%EB%89%B4%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=saveMenuRightIndiv">🔗API 확인하기 ></a></td></tr></tbody></table>

***