Developer Console 앱 생성
Developer Console 앱은 인증 클라이언트, 사용할 온톨로지 및 플랫폼 API 범위와 생성 SDK를 묶습니다. 앱 생성 권한이 있어야 + New application이 표시됩니다.
앱 유형과 인증
- Developer Console에서 + New application을 선택합니다.
- Basic information에서 앱 이름과 아이콘을 정합니다. 아이콘은 사용자 동의 화면에 표시합니다.
- 프런트엔드는 Client-facing application을 선택합니다. 서비스 사용자로 실행하는 서버는 Backend service를 선택하고 서버용 인증 경로를 사용합니다.
- 클라이언트 앱의 Permissions > Authorization code grant에 로컬 개발 리다이렉트 URL을 설정합니다. 예제는 http://localhost:8080/auth/callback입니다.
HTTP 로컬 개발에는 Control Panel의 CORS 정책에 http://localhost:8080을 추가해야 합니다. 본인이나 관리자가 CORS를 구성할 수 없으면 리다이렉트를 https://localhost:8080/auth/callback으로 설정하는 경로를 사용합니다. 로컬 개발 서버도 해당 HTTPS 주소에서 콜백을 처리하도록 구성해야 합니다.
SDK와 리소스 선택
Resources에서 Yes, generate an Ontology SDK를 선택합니다.
사용할 온톨로지를 선택합니다. 이름 공간과 관계없이 접근 가능한 온톨로지를 선택할 수 있지만, SDK를 한 번 생성하면 연결한 온톨로지를 바꿀 수 없습니다.
가져올 객체, 액션과 다른 온톨로지 리소스를 선택합니다.
선택은 언어별 바인딩과 전용 문서의 생성 대상 및 앱의 기본 OAuth 리소스 제한에 함께 반영됩니다. 선택했다고 사용자에게 데이터 권한이 새로 생기는 것은 아닙니다.
플랫폼 API도 필요하면 Platform SDK 탭에서 프로젝트 리소스와 작업을 추가합니다.
허용 작업의 범위와 API 보안 모드는 앱 제한을 따릅니다. 내부 서비스 접근 가능 여부까지 검토해야 합니다.
앱과 첫 SDK 생성
설정을 검토하고 Create application을 선택합니다. 앱 생성 뒤 Generate first version을 선택해야 첫 SDK 패키지를 만듭니다.
모든 새 앱은 Restricted입니다. 생성 마법사에 제한 여부 선택은 없습니다. 프로젝트 밖 관리 리소스 등 넓은 범위가 필요한 앱은 생성 뒤 OAuth & restrictions > Application restrictions에서 Unrestricted를 선택합니다. 이 변경은 기존 프로젝트 및 작업 제한을 제거하므로 필요한 인증 scope 조건을 먼저 확인합니다.
생성된 API 문서
선택한 각 객체, 액션과 함수에는 앱 전용 문서를 생성합니다. 속성의 반환과 입력 매개변수에 맞는 예제를 볼 수 있으며 언어 메뉴로 TypeScript, Python과 cURL 등 표시를 바꿉니다.
SDK는 언어별 OSDK 참조의 계약에 맞춰 앱에 설치합니다. 앱의 사용량 지표는 인증 방식에 따라 수집 여부가 달라집니다.