개요
PROTOCOL22-API
PROTOCL22는 다보리SSO에서 OwnerKey를 활용하여 MAIN APP과 GUEST APP간의 API를 공유하여 특정 API에 접근하는 방식입니다.
OwnerKey란?
PROTOCAL22-API를 사용하기 위해서는 OwnerKey 발급이 필요합니다.
여기서 OwnerKey는 APP 등록시 main APP에 등록된 API 서버와 DB 접근 권한이 설정된 암호화 KEY입니다.
발급된 OwnerKey를 guest APP에 저장하여 PROTOCL22-API를 사용할 수 있습니다.
OwnerKey 발급방법
1. main app을 등록한 dabory 계정으로 로그인합니다.
2. guest app 등록을 위해서 My App 메뉴를 클릭합니다.
3. 좌측 메뉴에서 App Manager를 클릭합니다.
4. 등록한 app중 Owner key를 공유할 app을 클릭합니다.
5. GuestApp 탭을 클릭합니다.
6. a부터 c까지 입력 및 선택합니다.
ⓐ Guest App Name : Owner Key의 이름
ⓑ OwnerCode : Owner Key의 제한방식
- owner : 모든 api 허용
- keypair :
- dbupdate :
- limited : 일부 api만 허용
ⓒ AppType : guest app의 type
7. Download .owner-key 버튼을 클릭하여 Owner key를 download 합니다.
8. MainApp 탭을 누른뒤 save 버튼을눌러 저장합니다.
9. 생성된 .owner-key를 확인하고 frontend 소스코드를 open합니다.
10. .env 파일에 MAIN_API_OWNER_KEY 변수를 추가하고 생성된 owner key의 값을 넣어줍니다.
Protocol22-API 종류
1. Javascript (js 방식)
2. GO (webapp 방식)
3. Laravel (webapp 방식)
js방식과 app방식의 차이점
구분 | Javascript | WebApp |
호출 | 프론트엔드(브라우저) | 백엔드(Laravel, Go) |
목적 | Guest APP에서 직접 API 요청 | 서버간 api 요청 (Backend to Backend) |
호출방식 | $.fn.ownerKeyLinker.ownerApp() 호출 | callOwnerApi() 호출 |
OwnerKey 저장 | 스크립트에 직접입력 | 특정 변수에 저장후 session 활용 |
인증방식 | OnwerKey를 직접 포함하여 API 요청 | GateToken을 세션에서 불러와 API 요청 |
보안 | 상대적으로 낮음 (클라이언트에서 호출) | 상대적으로 높음(서버에서 요청) |
사용예제 | <script> 태그로 js 라이브러리 로드후 호출 | Laravel, Go 등의 서버 코드에서 API 호출 |
No Comments