OwnerKey를 활용한 게시판 연동 예제
시작하기 전에
이 문서는 OwnerKey를 사용하여 Guest App에서 Owner App의 게시판 데이터 연동할 때 필요한 참고정보를 제공 및 설명합니다.
예제실행전에 아래 준비사항들을 반드시 준비해주시기 바랍니다.
- 오너 사이트로부터 제공받은 OwnerKey (env 파일에 저장)
- css 파일( 디자인 커스터마이징의 경우 )
- app 등록하기
- owner app의 게시판 코드
- env 파일에 저장된 OWNER_APP_NAME
게시판 연동의 흐름
1. 제공받은 OwnerKey를 env 파일에 저장합니다.
2. owner app의 게시판 정보를 기반으로 guest app에 저장합니다.
게시판 연동예제
위 이미지는 dabory compoable 사이트의 USE CASES 게시판(블로그)입니다. 이 게시판을 factory 사이트에서 연동하겠습니다.
- env 파일에 오너키 저장
먼저 .env 파일에 OwnerKey를 저장해야합니다. 만약 설정할 오너앱이 두개 이상 이상이라면 오너앱의 개수에 맞게 변수 끝에 _숫자를 입력하여 순서에 맞게 변수명을 입력합니다.
# [protocol22]
OWNER_APP_NAME=YOUR_OWNER_APP_NAME # Owner APP의 이름 (자유롭게 지정)
GUEST_APP_OWNER_KEY=YOUR_OWNER_KEY # Guest APP에서 발급받은 OwnerKey 입력
GUEST_APP_OWNER_URL=YOUR_OWNER_URL # Owner APP의 URL 입력 (ex.https://composable.daboryhost.com)
OWNER_APP_NAME2=YOUR_OWNER_APP_NAME_2
GUEST_APP_OWNER_KEY2=YOUR_OWNER_KEY_2
GUEST_APP_OWNER_URL2=YOUR_OWNER_URL_2
OWNER_APP_NAME3=YOUR_OWNER_APP_NAME_3
GUEST_APP_OWNER_KEY3=YOUR_OWNER_KEY_3
GUEST_APP_OWNER_URL3=YOUR_OWNER_URL_3- OwnerKey는 GUSET APP이 MAIN APP의 API를 호출할 때 사용되는 고유한 인증 키입니다.
- WebApp 방식에서는 OwnerKey를 .env 파일에 저장하고, API 요청 시 세션을 활용하여 사용합니다.
- 오너앱의 게시판 URL 확인
만약 오너사이트에서 제공받으려는 게시판 url을 모른다면 오너 사이트에서 해당 게시판 url을 확인할 수 있습니다.
(1). 오너 사이트인 composable에서 Use Cases를 클릭합니다.
(2). /bbs/list/use-cases를 복사하여 메모장에 붙여넣습니다.
- 홈페이지 메뉴 등록
(1). 슈퍼 유저 메뉴 - 시스템 관리(주의) - 홈페이지 메뉴 불러오기 메뉴로 진입합니다.
(2). 우측 상단의 메인메뉴 추가 버튼을 클릭합니다.
(3). 입력창을 모두 입력한 뒤 저장버튼을 클릭하여 저장합니다.
메뉴코드 : 메뉴코드는 메뉴의 순서와 상/하위 메뉴를 지정할 수 있습니다 . 예를들어 메뉴코드가 100000인 메뉴가 홈페이지 헤더 메뉴에 가장 먼저 위치하고 200000~900000인 메뉴가 순서대로 노출됩니다. 301000, 302000은 300000의 하위메뉴를 뜻합니다.
메뉴명 : 홈페이지 나타내려는 메뉴(게시판)의 이름
페이지 URI : 오너로부터 제공받은 게시판 URL을 입력한뒤 가장 끝부분에 env파일에 저장된 OWNER_APP_NAME 을 입력합니다.
예를들어 오너 사이트에서 제공받은 게시판 URI가 /bbs/list/use-cases 고 env파일에 저장된 OWNER_APP_NAME이 composable이라면 /bbs/list/use-cases/composable 이라고 입력합니다.
언어구분 : 원하는 언어형식을 선택합니다.
링크타입 : 게시판을 선택합니다.
종류 : primary를 선택합니다.
메뉴표시 누락 : 체크시 홈페이지에서 해당 메뉴가 노출되지 않습니다.
target=_blank 인가 : 체크시 홈페이지에서 해당 메뉴를 클릭했을때 새탭으로 열립니다.
PC에서누락 : 체크시 PC로 홈페이지에 접속했을때 해당 메뉴가 노출되지 않습니다.
Mobile에서누락 : 체크시 모바일로 홈페이지에 접속했을 때 해당 메뉴가 노출되지 않습니다.
테블릿에서누락 : 체크시 테블릭PC로 홈페이지에 접속했을 때 해당 메뉴가 노출되지 않습니다.
로그인경우만 : 체크시 로그인했을 경우에만 해당 메뉴가 노출됩니다.
로그아웃경우만 : 체크시 로그아웃했을 경우에만 해당 메뉴가 노출됩니다.
(4). 홈페이지에 접속하여 추가한 게시판이 노출되었는지 확인합니다.
(5). composable과 게시판 연동이 완료되었습니다.
