djb-eapim/eapim-portal
1
0
Fork 0
Code Issues Pull Requests Actions 10 Packages Projects Releases Wiki Activity
Files
designs/260630
eapim-portal/개발자포탈.md
T
Rinjae cc925e0475 init
2025-08-07 15:36:26 +09:00

1207 lines
36 KiB
Markdown
Raw Permalink Blame History

# 개발자 포탈 사용 가이드
## 설치 후 작업
1. 개요
개발자 포탈 최초 설치 후, 최초 관리자를 등록
한다.
2. 화면 캡쳐
![최초 ADMIN 등록](docs%2Fimages%2Fadmin_register_view.png)
3. 화면 소개
최초 설치 후 관리자 정보를 등록한다. (최초 1회만 등록 가능)
4. 화면 요소
- 입력 항목
- 이메일 주소 : 로그인 시 사용
- 비밀번호
- 비밀번호 확인 : 입력한 비밀번호와 동일
- 이름
- 휴대폰 번호
- 저장 버튼 : 입력한 관리자 정보를 저장한다.
5. 작업 가이드
- 신규 관리자 등록: http://서버/admin_register_view.do 에 접속하여 신규 관리자 정보를 등록한다.
6. 문제 해결
admin_register_view.do 페이지가 열리지 않는 경우 이미 사용자가 등록되어 있는지 확인한다.
## 사용자 관리
1. 개요
- 내부 사용자 정보와 기업 사용자 정보를 관리한다.
- 기업 사용자 회원 가입을 위한 약관을 관리한다.
- 기업 사용자 회원 가입 기능을 제공한다.
2. 구성 요소
- 내부 사용자 관리
- 기업 사용자 관리
- 기업 사용자 회원 가입
- 약관 관리
### 내부 사용자 관리
1. 개요
포탈 운영을 위한 내부 사용자 정보를 관리한다.
2. 구성 요소
- 내부 사용자 목록
- 내부 사용자 등록
- 내부 사용자 수정
#### 내부 사용자 목록
1. 개요
포탈에 등록된 내부 사용자 목록을 조회한다.
2. 화면 캡쳐
![내부사용자 목록](docs%2Fimages%2Fstaff_list.png)
3. 화면 소개
- 상단에 검색 조건과 검색 버튼이 있으며, 검색 조건에 따라 내부 사용자 목록을 조회한다.
- 내부 사용자 목록은 페이징 처리되어 있다.
- 내부 사용자 정보 등록, 수정 및 삭제 기능을 제공한다.
4. 화면 요소
- 검색 조건
- 조회 버튼 : 검색 조건에 따라 내부 사용자 목록을 조회한다.
- 삭제 버튼 : 선택된 사용자를 삭제한다.
- 등록 버튼 : 새로운 내부 사용자 등록화면으로 이동한다.
- 사용자 목록
- ID
- 이름
- 상태
- 수정 버튼 : 선택된 사용자 수정화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근 : 사용자 관리 > 내부 사용자 관리를 클릭한다.
- 등록된 사용자 조회: 검색 조건 입력 후 조회 버튼을 클릭하여 사용자 목록을 조회한다.
- 신규 사용자 등록 : 등록 버튼을 클릭하여 신규 사용자를 등록한다.
- 기존 사용자 정보 수정 : 사용자 목록에서 수정 버튼을 클릭하여 기존 사용자 정보를 수정한다.
- 사용자 삭제 : 삭제할 사용자의 체크박스를 선택하고 삭제 버튼을 클릭하여 사용자를 삭제한다.
#### 내부 사용자 등록
1. 개요
포탈에 새로운 내부 사용자를 등록한다.
2. 화면 캡쳐
![내부 사용자 등록](docs%2Fimages%2Fstaff_user_register.png)
3. 화면 소개
- 사용자의 기본 정보 등록 폼을 제공한다.
4. 화면 요소
- 입력 항목
- 이메일 주소 : 로그인 시 사용
- 비밀번호
- 비밀번호 확인 : 입력한 비밀번호와 동일
- 이름
- 휴대폰 번호
- 저장 버튼 : 입력한 사용자 정보를 저장한다.
- 목록 버튼 : 사용자 목록 화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근: 내부 사용자 목록 화면에서 등록 버튼을 클릭한다.
- 사용자 등록: 정보 입력 후 저장 버튼을 클릭하여 사용자를 등록한다.
- 등록 취소: 목록 버튼을 클릭하여 사용자 목록 화면으로 이동한다.
#### 내부 사용자 수정
1. 개요
포탈에 등록된 내부 사용자 정보를 수정한다.
2. 화면 캡쳐
![내부 사용자 수정](docs%2Fimages%2Fstaff_user_edit.png)
3. 화면 소개
- 선택한 내부 사용자의 입력 정보 수정 폼을 제공한다.
4. 화면 요소
- 입력 항목
- 고유ID: 수정 불가
- 이메일 주소 : 수정 불가
- 이름
- 휴대폰 번호
- 사용자 상태 : 가입승인대기, 활성화, 비활성화, 잠김
- 비밀번호 잠김: 잠금/해제
- 잠금 횟수 : 로그인 시 비밀번호 오류 횟수
- 가입일자
- 잠금최종시점 : 잠금횟수 초과로 로그인이 잠긴 일자
- 비밀번호변경일자
- 저장 버튼 : 변경된 사용자 정보를 저장한다.
- 목록 버튼 : 사용자 목록 화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근: 내부 사용자 목록에서 원하는 사용자의 수정버튼을 클릭한다.
- 사용자 정보 변경 : 이름, 휴대폰 번호를 변경 후 저장한다.
- 사용자 상태 변경: 사용자 상태를 변경후 저장한다.
- 비밀번호 잠금 해제 : 비밀번호 잠금을 해제로 변경 후 저장한다.
### 기업 사용자 관리
1. 개요
포탈 서비스를 사용하기 위한 외부 기업 고객의 사용자 정보를 관리한다.
2. 구성 요소
- 기업 사용자 목록
- 기업 사용자 등록
- 기업 사용자 수정
#### 기업 사용자 목록
1. 개요
포탈에 등록된 기업 사용자 목록을 조회한다.
2. 화면 캡쳐
![기업 사용자 목록](docs%2Fimages%2Fent_user_list.png)
3. 화면 소개
- 상단에 검색 조건과 검색 버튼이 있으며, 검색 조건에 따라 기업 사용자 목록을 조회한다.
- 기업 사용자 목록은 페이징 처리되어 있다.
- 기업 사용자 정보 등록, 수정 및 삭제 기능을 제공한다.
4. 화면 요소
- 검색 조건
- 조회 버튼 : 검색 조건에 따라 내부 사용자 목록을 조회한다.
- 삭제 버튼 : 선택된 사용자를 삭제한다.
- 등록 버튼 : 새로운 내부 사용자를 등록한다.
- 사용자 목록
- ID
- 회사명
- 이름
- 상태
- 수정 버튼 : 선택된 사용자 수정화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근: 사용자 관리 > 기업 사용자 관리를 클릭한다.
- 등록된 사용자 조회: 검색 조건 입력 후 조회 버튼을 클릭하여 기업 사용자 목록을 조회한다.
- 신규 사용자 등록 : 등록 버튼을 클릭하여 신규 기업 사용자를 등록한다.
- 기존 사용자 정보 수정 : 기업 사용자 목록에서 수정 버튼을 클릭하여 기존 사용자 정보를 수정한다.
- 사용자 삭제 : 삭제할 기업 사용자의 체크박스를 선택하고 삭제 버튼을 클릭하여 기업 사용자를 삭제한다.
#### 기업 사용자 등록
1. 개요
포탈에 새로운 기업 사용자를 등록한다.
2. 화면 캡쳐
![기업 사용자 등록](docs%2Fimages%2Fent_user_register.png)
3. 화면 소개
- 기업 사용자의 기본 정보 등록 폼과 기업 정보 등록폼을 제공한다.
4. 화면 요소
- 입력 항목 (개인정보)
- 이메일 주소 : 로그인 시 사용
- 비밀번호
- 비밀번호 확인 : 입력한 비밀번호와 동일
- 이름
- 휴대폰 번호
- 입력 항목 (기업정보)
- 회사명
- 대표자명
- 사업자 등록번호
- 법인등록번호
- 업종코드
- 우편번호
- 주소
- 상세주소
- 사무실 전화번호
- 팩스번호
- 저장 버튼 : 입력한 정보를 저장한다.
- 목록 버튼 : 기업 사용자 목록 화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근: 기업 사용자 목록 화면에서 등록 버튼을 클릭한다.
- 기업 사용자 등록: 정보 입력 후 저장 버튼을 클릭하여 기업 사용자를 등록한다.
- 등록 취소: 목록 버튼을 클릭하여 기업 사용자 등록을 취소한다.
#### 기업 사용자 수정
1. 개요
포탈에 등록된 기업 사용자 정보를 수정한다.
2. 화면 캡쳐
![기업 사용자 수정](docs%2Fimages%2Fent_user_edit.png)
3. 화면 소개
- 기업 사용자의 기본 정보 수정 폼과 기업 정보 수정 폼을 제공한다.
4. 화면 요소
- 입력 항목 (개인정보)
- 고유ID: 수정 불가
- 이메일 주소 : 수정 불가
- 이름
- 휴대폰 번호
- 사용자 상태 : 가입승인대기, 활성화, 비활성화, 잠김
- 비밀번호 잠김: 잠금/해제
- 잠금 횟수 : 로그인 시 비밀번호 오류 횟수
- 가입일자
- 잠금최종시점 : 잠금횟수 초과로 로그인이 잠긴 일자
- 비밀번호변경일자
- 입력항목 (기업정보)
- 회사명
- 대표자명
- 사업자 등록번호
- 법인등록번호
- 업종코드
- 우편번호
- 주소
- 상세주소
- 사무실 전화번호
- 팩스번호
- 저장 버튼 : 변경된 기업 사용자 정보를 저장한다.
- 목록 버튼 : 기업 사용자 목록 화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근: 기업 사용자 목록 화면에서 원하는 사용자의 수정 버튼을 클릭한다.
- 기업 사용자 정보 변경: 입력항목을 변경 후 저장한다.
- 기업 사용자 상태 변경: 기업 사용자 상태를 변경후 저장한다.
- 비밀번호 잠금 해제 : 비밀번호 잠금을 해제로 변경 후 저장한다.
- 등록 취소 : 목록 버튼을 클릭하여 기업 사용자 수정을 취소한다.
### 기업 사용자 회원 가입
1. 개요
기업 사용자가 회원 가입 후 관리자 승인을 받아 포탈을 사용한다.
2. 화면 캡쳐
![약관동의](docs%2Fimages%2Fuser_agreement.png)
![회원가입](docs%2Fimages%2Fuser_register.png)
3. 화면 소개
- 약관 동의 : 회원 가입을 위한 약관과 동의 체크 박스를 표시한다.
- 회원 가입 : 기업 사용자 입력 폼을 표시한다.
4. 화면 요소
- 이용약관
- 입력 항목
- 이용약관 동의
- 개인 정보 수집 및 이용 동의
- 전체 동의: 표시된 모등 약관에 동의한다.
- 등록 버튼: 회원 가입 화면으로 이동한다.
- 회원 가입
- 입력 항목
- 이메일 주소
- 인증 번호
- 신청자 명
- 비밀 번호
- 비밀 번호 확인
- 인증번호 발송 버튼: 입력한 이메일 주소로 인증 번호를 발송한다.
- 등록 버튼: 입력한 사용자 정보를 등록한다.
5. 작업 가이드
- 메뉴 접근: 로그인 화면에서 회원 가입을 클릭한다.
- 약관 동의: 약관을 읽고 동의에 체크 후 등록 버튼을 클릭하여 회원 가입 화면으로 이동한다.
- 회원 등록: 기업 사용자 정보 및 전송된 인증번호를 입력 후 등록 버튼을 클릭한다. 정상적으로 등록 시 완료화면이 표시된다.
6. 문제 해결
- 회원 가입 시 약관을 표시하기 위해서는 [약관관리](#약관-관리)에 필요한 약관을 등록해야 한다.
- 약관 동의: 회원 가입을 위한 약관에 동의하지 않으면 회원 가입 등록화면으로 이동하지 않는다.
- 인증 번호 오류: 발송된 인증번호와 일치하지 않으면 정상적으로 등록이 불가능하다.
- 인증번호 발송 오류 : 메일 발송 시스템과 연계 오류시 사용이 불가능하다.
- 사용자 상태 오류 : 사용자 승인 전까지는 로그인이 불가능하다.
### 약관 관리
1. 개요
- 포탈 운영을 위한 약관을 관리한다.
- 관리 약관의 종류는 서비스 이용약관, 개인정보 처리방침, 정보 제공 동의 , 마케팅 정보 수신동의 등이 있다.
- 등록된 약관은 상태로 관리되며, 발행 상태의 약관이 회원 가입시 표시된다. 최초 등록시 신규(TEMP)상태로 저장되며, 변경시 임시저장(DRAFT)로 관리된다.
- 임시저장 상태에서 발행을 하면 발행 (PUBLISHED)상태로 변경되며, 기존 발행(PUBLISHED) 상태의 약관은 보관 (ARCHIVED) 상태로 변경된다.
2. 화면 캡쳐
![약관관리](docs%2Fimages%2Fagreements.png)
3. 화면 소개
- 좌측에 사용가능한 약관 목록이 표시한다.
- 약관을 선택하면 해당 약관의 정보가 표시한다.
4. 화면 요소
- 약관 목록: 선택 하면 우측에 약관 정보를 표시한다.
- 입력 항목
- 제목
- 버전: 자동 생성
- 약관 내용: 에디터를 사용하여 약관 작성
- 발행 일자: 자동 생성 (발행 시)
- 상태: TEMP, DRAFT, PUBLISHED, ARCHIVED 자동 생성
- 신규 버튼: 새로운 버전의 약관을 생성한다.
- 저장 버튼: 편집한 약관을 저장한다.
- 삭제 버튼: 현재 표시되는 약관을 삭제한다.
- 발행 버튼: 현재 표시되는 약관을 발행한다.
- 버전 목록: 선택하면 해당 버전의 약관 내용이 표시된다.
5. 작업 가이드
- 메뉴 접근: 시스템 관리 > 약관 관리를 클릭한다.
- 약관 신규 등록: 신규 버튼을 클릭하여 약관을 등록 후 저장한다.
- 약관 내용 수정: 원하는 버전의 약관을 클릭 후 내용 수정 후 저장한다.
- 약관 발행: 원하는 버전의 약관을 클릭후 발행 버튼을 클릭한다.
- 약관 삭제: 원하는 버전의 약관을 클릭 후 삭제 버튼을 클릭한다.
6. 문제 해결
- 발행된 약관은 수정 삭제가 불가능 하므로, 수정이 필요하면 새로운 약관 발행해야 한다.
## API 관리
1. 개요
OPEN API 서비스를 위한 API 정보를 관리한다.
2. 구성 요소
- API 관리 목록
- API 등록
- API 수정
### API 관리 목록
1. 개요
포탈에 등록된 API 목록을 조회한다.
2. 화면 캡쳐
![API 목록](docs%2Fimages%2Fapi_mgmt_list.png)
3. 화면 소개
- 상단에 검색 조건과 검색 버튼이 있으며, 검색 조건에 따라 API 목록을 조회한다.
- API 목록은 페이징 처리되어 있다.
- API 등록, 수정 및 삭제 기능을 제공한다.
4. 화면 요소
- 검색 조건
- 검색항목 : 이름, URL 중 선택
- 검색어 : 검색 항목에 따라 입력
- 조회 버튼 : 검색 조건에 따라 내부 API 목록을 조회한다.
- 삭제 버튼 : 선택된 API를 삭제한다.
- 등록 버튼 : 새로운 API 등록화면으로 이동한다.
- API 목록
- ID : API ID
- 이름 : API 이름
- URL : API URL
- 수정 버튼 : 선택된 API 수정화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근: API관리 > API 관리를 클릭한다.
- 등록된 API 조회: 검색 조건 입력 후 조회 버튼을 클릭하여 API 목록을 조회한다.
- 신규 API 등록 : 등록 버튼을 클릭하여 신규 API를 등록한다.
- 기존 API 정보 수정 : API 목록에서 수정 버튼을 클릭하여 기존 API 정보를 수정한다.
- API 삭제 : 삭제할 API의 체크박스를 선택하고 삭제 버튼을 클릭하여 API를 삭제한다.
### API 등록
1. 개요
포탈에 새로운 API를 등록한다.
2. 화면 캡쳐
![API 등록](docs%2Fimages%2Fapi_mgmt_register.png)
3. 화면 소개
- 신규 API 정보를 등록 폼을 제공한다.
4. 화면 요소
- 입력 항목
- 이름: 표시될 API 이름
- method: POST, GET, PUT, DELETE 등
- 도메인: 게이트웨이 호출 도메인 정보 (ex: http://localhost:8080)
- Path: 게이트웨이 호출 URL 정보 (ex: /api/v1/users)
- 설명: API에 대한 설명 (WYSIWYG 에디터 제공)
- API 스펙: swagger 형식의 json, editor로 작성
- 첨부파일: 선택한 파일 첨부
- 응답: json 응답 예제
- 저장 버튼 : 입력한 API 정보를 저장한다.
- 목록 버튼 : API 목록 화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근: API관리 화면에서 등록 버튼을 클릭한다.
- API 정보 등록 : API 정보를 입력 후 저장한다.
- API Swagger 작성: 표시된 샘플을 활용하여 API 스펙을 작성한다.
- 첨부 파일 등록: 첨부 파일 파일선택을 클릭하여 첨부할 파일을 선택 후 저장한다.
- 등록 취소: 목록 버튼을 클릭하여 API 목록 화면으로 이동한다.
### API 수정
1. 개요
포탈에 등록된 API 정보를 수정한다.
2. 화면 캡쳐
![API 수정](docs%2Fimages%2Fapi_mgmt_edit.png)
3. 화면 소개
- 등록된 API 정보를 수정 폼을 제공한다.
- 등록된 첨부파일 목록을 제공한다.
4. 화면 요소
- 입력 항목
- 이름: 표시될 API 이름
- method: POST, GET, PUT, DELETE 등
- 도메인: 게이트웨이 호출 도메인 정보 (ex: http://localhost:8080)
- Path: 게이트웨이 호출 URL 정보 (ex: /api/v1/users)
- 설명: API에 대한 설명 (WYSIWYG 에디터 제공)
- API 스펙: swagger 형식의 json, editor로 작성
- 첨부파일: 등록된 첨부 파일 목록
- 응답: json 응답 예제
- 저장 버튼 : 변경한 API 정보를 저장한다.
- 목록 버튼 : API 목록 화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근: API관리 화면에서 원하는 API의 수정 버튼을 클릭한다.
- API 정보 변경: API 정보를 변경 후 저장한다.
- 첨부 파일 변경: 기존에 등록된 파일의 휴지통 버튼을 클릭하여 삭제 후, 새로운 첨부 파일을 선택 후 저장한다.
- 변경 취소 : 목록 버튼을 클릭하여 API 목록 화면으로 이동한다.
## API 문서
1. 개요
API 관리에서 등록한 API의 정보 및 Swagger UI를 제공한다.
2. 구성 요소
- API 목록
- API 상세
### API 목록
1. 개요
API관리에서 등록한 API 를 목록 형태로 제공한다.
2. 화면 캡쳐
![API 목록](docs%2Fimages%2Fapi_list.png)
3. 화면 소개
- 상단에 검색 조건과 검색 버튼이 있으며, 검색 조건에 따라 API 목록을 조회한다.
- API 목록은 페이징 처리되어 있다.
4. 화면 요소
- 검색 조건
- API이름
- URL
- 검색 버튼
- API 목록
- API이름
- URL
5. 작업 가이드
- 메뉴 접근: 상단 API를 클릭한다.
- API 검색: API이름 또는 URL 을 입력 후 검색 버튼을 클릭한다.
- API 보기: API 목록에서 원하는 API 를 선택한다.
### API 상세
1. 개요
OPEN API 서비스를 제공하기 위한 API 정보를 Swagger UI를 통해 제공한다.
2. 화면 캡쳐
![API 기본 정보](docs%2Fimages%2Fapi_detail_1.png)
![Swagger UI](docs%2Fimages%2Fapi_detail_2.png)
3. 화면 소개
- API 정보 탭과 DOCUMENT 탭으로 구성되어 있다.
- API 정보 탭을 선택하면 기본 정보 및 설명, 첨부파일 다운로드를 제공한다.
- DOCUMENT 탭을 선택하면 Swagger UI를 제공한다.
4. 화면 요소
- API 기본 정보 탭
- 기본 정보
- 첨부 파일 목록
- DOCUMENT 탭
- Swagger UI
- 목록 버튼
5. 작업 가이드
- 메뉴 접근: API 목록에서 원하는 API 를 선택한다.
- 첨부 파일 다운로드 : 첨부 파일 목록에서 파일 이름을 클릭한다.
- API 테스트: Swagger UI에서 필요한 변수 입력 후 Try it out을 클릭한다.
- 목록 이동: 목록 버튼을 클릭하여 API 목록 화면으로 이동한다.
## 커뮤니티
1. 개요
사용자 커뮤니케이션을 위한 게시판 및 FAQ 기능을 제공한다.
2. 구성 요소
- 게시판 관리
- FAQ 관리
### 게시판 관리
1. 개요
사용자 커뮤니케이션을 위한 게시판 관리 기능을 제공한다.
2. 구성 요소
- 게시판 목록
- 게시판 등록
- 게시판 수정
- 게시글 목록
- 게시글 등록
- 게시글 조회
- 게시글 수정
#### 게시판 목록
1. 개요
포탈에 등록된 게시판 목록을 조회한다.
2. 화면 캡쳐
![게시판 관리 목록](docs%2Fimages%2Fboard_mgmt_list.png)
3. 화면 소개
- 상단에 검색 조건과 검색 버튼이 있으며, 검색 조건에 따라 내부 게시판 목록을 조회한다.
- 게시판 목록은 페이징 처리되어 있다.
- 게시판 정보 등록, 수정 및 삭제 기능을 제공한다.
- 게시판에 등록된 게시글 조회 화면으로 이동 가능하다.
4. 화면 요소
- 검색 조건
- 게시판 이름
- 조회 버튼 : 검색 조건에 따라 게시판 목록을 조회한다.
- 삭제 버튼 : 선택한 게시판을 삭제한다.
- 등록 버튼 : 게시판 등록 화면으로 이동한다.
- 게시판 목록
- ID
- 이름
- 사용 여부
- 수정 버튼 : 게시판 수정 화면으로 이동한다.
- 게시물 보기 버튼 : 게시글 목록 화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근: 커뮤니티 관리 > 게시판 관리를 클릭한다.
- 등록된 게시판 조회 : 게시판 이름을 입력 후 조회 버튼을 클릭한다.
- 게시판 삭제 : 삭제할 게시판을 선택 후 삭제 버튼을 클릭한다.
- 신규 게시판 등록 : 등록 버튼을 클릭한다.
- 기존 게시판 수정 : 수정 버튼을 클릭한다.
- 등록된 게시물 보기 : 게시물 보기 버튼을 클릭한다.
#### 게시판 등록
1. 개요
포탈에 게시판을 등록한다.
2. 화면 캡쳐
![게시판 등록](docs%2Fimages%2Fboard_mgmt_register.png)
3. 화면 소개
- 게시판 등록 폼을 제공한다.
4. 화면 요소
- 입력 항목
- 이름
- 게시판 소개
- 답장 가능 여부
- 파일 첨부 가능 여부
- 첨부 가능 파일 숫자
- 사용 여부
- 권한 설정
- 저장 버튼 : 입력한 게시판 정보를 저장한다.
- 목록 버튼 : 게시판 목록 화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근: 게시판 목록에서 등록 버튼을 클릭한다.
- 게시판 등록: 정보 입력 후 저장 버튼을 클릭한다.
- 게시판 권한 부여: 권한 별로 읽기, 쓰기, 수정, 삭제, Admin 권한의 체크박스를 선택 후 저장 버튼을 클릭한다.
- 등록 취소: 목록 버튼을 클릭한다.
#### 게시판 수정
1. 개요
포탈에 등록된 게시판의 정보를 수정한다.
2. 화면 캡쳐
![게시판 수정](docs%2Fimages%2Fboard_mgmt_edit.png)
3. 화면 소개
- 게시판 수정 폼을 제공한다.
4. 화면 요소
- 입력 항목
- 이름
- 게시판 소개
- 답장 가능 여부
- 파일 첨부 가능 여부
- 첨부 가능 파일 숫자
- 사용 여부
- 권한 설정
- 저장 버튼 : 입력한 게시판 정보를 저장한다.
- 목록 버튼 : 게시판 목록 화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근: 게시판 목록에서 원하는 게시판의 수정 버튼을 클릭한다.
- 게시판 정보 수정: 정보 입력 후 저장 버튼을 클릭한다.
- 게시판 권한 부여: 권한 별로 읽기, 쓰기, 수정, 삭제, Admin 권한의 체크박스를 선택 후 저장 버튼을 클릭한다.
- 수정 취소: 목록 버튼을 클릭한다.
#### 게시글 목록
1. 개요
게시판에 등록된 게시글을 관리한다.
2. 화면 캡쳐
![게시글 목록](docs%2Fimages%2Farticle_mgmt_list.png)
3. 화면 소개
- 상단에 검색 조건과 검색 버튼이 있으며, 검색 조건에 따라 게시글 목록을 조회한다.
- 게시글 목록은 페이징 처리되어 있다.
- 게시글 등록, 수정 및 삭제 기능을 제공한다.
4. 화면 요소
- 검색 조건
- 검색항목 : 제목, 내용 중 선택
- 검색어 : 검색할 단어 입력
- 검색 버튼: 검색 조건에 따라 게시글 목록을 조회한다.
- 삭제 버튼: 선택한 게시글을 삭제한다.
- 등록 버튼: 게시글 등록 화면으로 이동한다.
- 게시글 목록
- 글 번호
- 제목
- 등록자
- 등록일
- 조회수
5. 작업 가이드
- 메뉴 접근 : 게시판 목록에서 원하는 게시판의 게시물 보기 버튼을 클릭한다.
- 게시글 검색 : 검색 조건을 선택 후 검색어를 입력하고 검색 버튼을 클릭한다.
- 게시글 등록 : 등록 버튼을 클릭한다.
- 게시물 삭제 : 삭제할 게시물을 선택 후 삭제 버튼을 클릭한다.
#### 게시글 등록
1. 개요
게시판에 새로운 게시글을 등록한다.
2. 화면 캡쳐
![게시글 등록](docs%2Fimages%2Farticle_mgmt_register.png)
3. 화면 소개
- 게시글 등록 폼을 제공한다.
4. 화면 요소
- 입력항목
- 작성자 (읽기 전용)
- 제목
- 내용
- 첨부 파일
- 저장 버튼 : 입력한 게시글 정보를 저장한다.
- 목록 버튼 : 게시글 목록 화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근 : 게시글 목록에서 등록 버튼을 클릭한다.
- 새로운 게시글 등록 : 제목, 내용을 입력 후 저장 버튼을 클릭한다.
- 첨부 파일 등록 : 파일 선택을 클릭하여 파일을 선택 후 저장 버튼을 클릭한다.
- 등록 취소 : 목록 버튼을 클릭한다.
#### 게시글 조회
1. 개요
게시글의 내용을 조회한다.
2. 화면 캡쳐
![게시글 조회](docs%2Fimages%2Farticle_mgmt_view.png)
3. 화면 소개
- 게시글의 내용을 조회한다.
4. 화면 요소
- 조회 항목
- 번호
- 제목
- 작성자
- 작성일
- 내용
- 목록 버튼 : 게시글 목록 화면으로 이동한다.
- 답글 작성 : 답글 작성 화면으로 이동한다.
- 수정 버튼 : 게시글 수정 화면으로 이동한다.
#### 게시글 수정
1. 개요
게시판에 등록된 게시글을 수정한다.
2. 화면 캡쳐
![게시글 등록](docs%2Fimages%2Farticle_mgmt_edit.png)
3. 화면 소개
- 게시글 수정 폼을 제공한다.
4. 화면 요소
- 입력 항목
- 작성자 (읽기 전용)
- 제목
- 내용 (WYSIWYG 에디터)
- 첨부 파일
- 저장 버튼 : 입력한 게시글 정보를 저장한다.
- 목록 버튼 : 게시글 목록 화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근 : 게시글 목록에서 원하는 게시글의 수정 버튼을 클릭한다.
- 게시글 수정 : 제목, 내용을 변경 후 저장 버튼을 클릭한다.
- 첨부 파일 변경: 기존에 등록된 파일의 휴지통 버튼을 클릭하여 삭제 후, 새로운 첨부 파일을 선택 후 저장한다.
- 수정 취소 : 목록 버튼을 클릭한다.
### FAQ 관리
1. 개요
사용자 커뮤니케이션을 위한 FAQ 관리 기능을 제공한다.
2. 구성 요소
- FAQ 목록
- FAQ 등록
- FAQ 수정
#### FAQ 목록
1. 개요
포탈에 등록된 FAQ 관리한다.
2. 화면 캡쳐
![게시글 목록](docs%2Fimages%2Ffaq_mgmt_list.png)
3. 화면 소개
- 상단에 검색 조건과 검색 버튼이 있으며, 검색 조건에 따라 FAQ 목록을 조회한다.
- FAQ 목록은 페이징 처리되어 있다.
- FAQ 등록, 수정 및 삭제 기능을 제공한다.
4. 화면 요소
- 검색 조건
- 검색 항목 : 제목, 내용 중 선택
- 검색어 : 검색할 단어 입력
- 조회 버튼: 검색 조건에 따라 FAQ 목록을 조회한다.
- 삭제 버튼: 선택한 FAQ를 삭제한다.
- 등록 버튼: FAQ 등록 화면으로 이동한다.
- FAQ 목록
- 번호
- 제목
- 수정
5. 작업 가이드
- 메뉴 접근 : 커뮤니티 관리 > FAQ관리를 클릭한다.
- FAQ 검색 : 검색 조건을 선택 후 검색어를 입력하고 조회 버튼을 클릭한다.
- FAQ 등록 : 등록 버튼을 클릭한다.
- FAQ 삭제 : 삭제할 FAQ를 선택 후 삭제 버튼을 클릭한다.
#### FAQ 등록
1. 개요
포탈에 새로운 FAQ를 등록한다.
2. 화면 캡쳐
![FAQ 등록](docs%2Fimages%2Ffaq_mgmt_register.png)
3. 화면 소개
- FAQ 등록 폼을 제공한다.
4. 화면 요소
- 입력 항목
- FAQ 제목
- 질문 내용
- 답변 내용 (WYSIWYG 에디터 제공)
- 저장 버튼 : 입력한 FAQ 정보를 저장한다.
- 목록 버튼 : FAQ 목록 화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근 : FAQ 목록에서 등록 버튼을 클릭한다.
- FAQ 등록 : 제목, 질문 내용, 답변 내용을 입력 후 저장 버튼을 클릭한다.
- 등록 취소 : 목록 버튼을 클릭한다.
#### FAQ 수정
1. 개요
포탈에 등록된 FAQ 내용을 수정한다.
2. 화면 캡쳐
![FAQ 수정](docs%2Fimages%2Ffaq_mgmt_edit.png)
3. 화면 소개
- FAQ 수정 폼을 제공한다.
4. 화면 요소
- 입력 항목
- FAQ 제목
- 질문 내용
- 답변 내용 (WYSIWYG 에디터 제공)
- 저장 버튼 : 수정된 FAQ 정보를 저장한다.
- 목록 버튼 : FAQ 목록 화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근 : FAQ 목록에서 선택할 FAQ의 수정 버튼을 클릭한다.
- FAQ 변경 : 제목, 질문 내용, 답변 내용을 변경 후 저장 버튼을 클릭한다.
- 변경 취소 : 목록 버튼을 클릭한다.
## 메시지 템플릿 관리
1. 개요
포탈에서 발송하는 이메일 및 SMS 포맷을 관리할 수 있는 기능을 제공한다.
포탈에 등록된 이벤트 발생 시 해당 템플릿을 사용하여 이메일 및 SMS를 발송한다.
2. 구성 요소
- 이메일 템플릿 관리
- SMS 템플릿 관리
### 이메일 템플릿 관리
1. 개요
포탈에서 발송하는 이메일 포맷을 관리할 수 있는 기능을 제공한다.
2. 화면 캡쳐
![이메일 템플릿 관리](docs%2Fimages%2Femail_template.png)
3. 화면 소개
- 템플릿 목록 을 제공한다.
- 템플릿 상세 정보를 제공한다.
4. 화면 요소
- 템플릿 목록 : 템플릿을 선택하면 선택한 템플릿의 정보가 우측에 표시된다.
- 템플릿 입력 항목:
- 제목
- 활성화 체크박스
- 내용 (WYSIWYG 에디터 제공)
- 저장 버튼 : 선택된 템플릿 정보를 저장한다.
5. 작업 가이드
- 메뉴 접근 : 시스템 관리 > 이메일 템플릿 관리를 클릭한다.
- 템플릿 등록 : 템플릿 목록에서 항목 선택 후 해당 템플릿의 내용을 입력 후 저장버튼을 클릭한다. 제목은 이메일 제목, 내용은 이메일로 발송된다. 제목, 내용에서 사용할 변수는 %변수명% 형태로 입력한다.
- 템플릿 미사용 : 템플릿 활성화 체크 박스를 해제 저장한다.
- 템플릿 사용 : 템플릿 활성화 체크 박스를 선택 후 저장한다.
### SMS 템플릿 관리
1. 개요
포탈에서 발송하는 SMS 포맷을 관리할 수 있는 기능을 제공한다.
2. 화면 캡쳐
![이메일 템플릿 관리](docs%2Fimages%2Femail_template.png)
3. 화면 소개
- 템플릿 목록을 제공한다.
- 템플릿 상세 정보를 제공한다.
4. 화면 요소
- 템플릿 목록 : 템플릿을 선택하면 선택한 템플릿의 정보가 우측에 표시된다.
- 템플릿 입력 항목:
- 제목
- 활성화 체크박스
- 내용 (텍스트 형태로 입력)
- 저장 버튼 : 선택된 템플릿 정보를 저장한다.
5. 작업 가이드
- 메뉴 접근 : 시스템 관리 > SMS 템플릿 관리를 클릭한다.
- 템플릿 등록 : 템플릿 목록에서 항목 선택 후 해당 템플릿의 내용을 입력 후 저장버튼을 클릭한다. 내용만 SMS로 발송된다.
- 템플릿 미사용 : 템플릿 활성화 체크 박스를 해제 저장한다.
- 템플릿 사용 : 템플릿 활성화 체크 박스를 선택 후 저장한다.
## API 키 관리
1. 개요
OPEN API 서비스 사용을 위한 API 키를 관리한다.
2. 구성 요소
- API 키 목록
- API 키 등록
- API 키 수정
### API 키 목록
1. 개요
기업사용자에게 발급된 API 키 목록을 조회할 수 있다.
2. 화면 캡쳐
![API 키 목록](docs%2Fimages%2Fapikey_mgmt_list.png)
3. 화면 소개
4.
- 상단에 검색 조건과 검색 버튼이 있으며, 검색 조건에 따라 API키 목록을 조회한다.
- API키 목록은 페이징 처리되어 있다.
- API키 등록, 수정 및 삭제 기능을 제공한다.
4. 화면 요소
- 검색 조건
- 조회 버튼 : 검색 조건에 따라 API키 목록을 조회한다.
- 삭제 버튼 : 선택된 API키를 삭제한다.
- 등록 버튼 : 새로운 API키를 등록한다.
- API 키 목록
- 기관
- 환경
- 이름
- 상태
- 수정 버튼 : 선택된 API키 수정화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근 : API관리 > API 키 관리를 클릭한다.
- 등록된 API키 조회 : 검색 조건 입력 후 API키 목록에서 조회 버튼을 클릭한다.
- 신규 API키 등록 : 등록 버튼을 클릭한다.
- API키 수정 : 수정 버튼을 클릭한다.
- API키 삭제 : 삭제할 API키의 체크박스를 선택하고 삭제 버튼을 클릭한다.
### API 키 등록
1. 개요
포탈에 등록된 기업사용자에게 새로운 API 키를 발급한다.
2. 화면 캡쳐
![API 키 등록](docs%2Fimages%2Fapikey_mgmt_register.png)
3. 화면 소개
- API 키 등록폼을 제공한다.
4. 화면 요소
- 입력 항목
- 이름
- 설명
- 환경 (개발/운영)
- 소유자
- Client ID (elink에서 발급된 Client ID)
- Client Secret (elink에서 발급된 Client Secret)
- 저장 버튼 : 입력한 정보를 저장한다.
- 목록 버튼 : API키 목록 화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근 : API키 목록에서 등록 버튼을 클릭한다.
- 신규 API키 발급: eLink에서 API키 발급 후, 발급받은 정보를 API키 등록 화면에서 입력 후 저장한다.
- 등록 취소: 목록 버튼을 클릭하여 API키 등록을 취소한다.
### API 키 수정
1. 개요
포탈에 등록된 기업사용자에게 발급된 API 키 정보를 수정한다.
2. 화면 캡쳐
![API 키 수정](docs%2Fimages%2Fapikey_mgmt_edit.png)
3. 화면 소개
- API 키 수정 폼을 제공한다.
4. 화면 요소
- 입력 항목
- 이름
- 설명
- 환경 (개발/운영)
- 소유자 (읽기 전용)
- Client ID (elink에서 발급된 Client ID)
- Client Secret (elink에서 발급된 Client Secret)
- 저장 버튼 : 입력한 정보를 저장한다.
- 목록 버튼 : API키 목록 화면으로 이동한다.
5. 작업 가이드
- 메뉴 접근 : API키 목록에서 원하는 API키의 수정 버튼을 클릭한다.
- API키 정보 변경: API키 정보를 수정 후 저장한다.
- 변경 취소: 목록 버튼을 클릭하여 API키 변경을 취소한다.
## 승인 관리
1. 개요
- 외부 사용자 가입 승인 및 API키 사용을 위한 승인 기능을 제공한다.
- 기업 사용자가 회원 가입을 하면 승인 요청이 생성된다.
- 기업 사용자가 API 키 사용 요청을 하면 승인 요청이 생성된다.
2. 구성 요소
- 승인 대기
- 승인 이력
- 승인 상세
### 승인 대기
1. 개요
사용자가 승인해야할 목록을 조회한다.
2. 화면 캡쳐
![승인 대기 목록](docs%2Fimages%2Fapproval_waiting.png)
3. 화면 소개
- 상단에 검색 조건과 검색 버튼이 있으며, 검색 조건에 따라 승인 대기 목록을 조회한다.
- 승인 대기 목록은 페이징 처리되어 있다.
4. 화면 요소
- 검색 조건
- 조회 버튼 : 검색 조건에 따라 승인 대기 목록을 조회한다.
- 승인 대기 목록
- 번호
- 유형 (회원가입/사용자 API키)
- 제목
- 요청 사용자
- 요청 일자
5. 작업 가이드
- 메뉴 접근 : 승인 관리 > 승인 대기를 클릭한다.
- 승인 대기 조회 : 검색 조건을 입력 후 조회 버튼을 클릭한다.
- 승인 상세 조회 : 승인 대기 목록에서 원하는 승인 대기 항목을 클릭한다.
### 승인 상세
1. 개요
사용자의 승인을 기다리는 내용을 조회한다.
2. 화면 캡쳐
![API키 승인상세](docs%2Fimages%2Fapproval_detail.png)
![사용자 승인상세](docs%2Fimages%2Fapproval_detail_user.png)
3. 화면 소개
- 승인 내용 을 표시한다.
- 승인 /반려 버튼을 제공한다.
4. 화면 요소
- 승인 상세 내용
- 목록 버튼 : 승인 대기 목록 화면으로 이동한다.
- 승인 버튼 : 승인한다.
- 반려 버튼 : 반려한다.
5. 작업 가이드
- 메뉴 접근: 승인 대기 목록에서 원하는 승인 대기 항목을 클릭한다.
- 승인: 승인 버튼을 클릭한다.
- 반려: 반려 버튼을 클릭한다.
- 취소: 목록 버튼을 클릭하여 승인 대기 화면으로 이동한다.
## 준비사항
- 포탈 구축 시 의사 결정 및 준비 항목
1. 시스템 알림 및 인증 번호 발송을 위해 이메일 연동 필요
2. 이메일, 발송 시스템 연계 방법
3. 사용자 등록 후 사용자 승인 사용 여부
4. API키 등록 / 변경시 승인 사용 여부
5. 사용자 등록시 약관 및 개인정보 처리 방침 동의 여부 제공
Reference in New Issue View Git Blame Copy Permalink