외부 학습 자료 JavaScript SDK

외부 학습 자료 SDK

본 문서는 엘리스의 외부 학습 자료를 개발의 가이드라인을 제공합니다.

이외의 다른 질문에 대해서는 엘리스로 연락 주시기 바랍니다.

SDK 설치 및 초기화

외부 학습 자료 Javascript SDK를 npm 패키지로 설치해주세요. 해당 패키지는 웹 환경에서 사용 가능합니다.

# npm
npm install @eliceio/cdk --save

# yarn
yarn add @eliceio/cdk

클래스

설치된 SDK에서 제공하는 클래스 EliceCDK를 사용하여 외부 학습자료 개발에 필요한 메서드와 속성을 사용할 수 있습니다.

import { EliceCDK } from '@eliceio/cdk';

const cdk = new EliceCDK({
  baseUrl: 'https://api-external-contents.elice.io',
});

초기화에 제공하는 옵션은 다음과 같습니다:

이름	타입	설명
baseUrl	string	Elice 플랫폼 API 서버의 base URL입니다. CORS 정책은 elice.io origin에 대한 요청만 허용합니다. 따라서 로컬 환경에서 테스트할 경우 프록시 서버를 구성하거나 브라우저의 CORS 기능을 비활성화해야 합니다.

CORS 에러를 해결하기 위해서는 아래 내용을 확인 부탁드립니다.

• CORS 플러그인 설치하기

플러그인 설치를 진행한 이후에도 CORS 에러가 발생한다면, 터미널에서 아래 명령어로 브라우저 CORS 기능을 비활성화하실 수 있습니다.

• 레퍼런스

# Windows
chrome.exe --user-data-dir="C://chrome-dev-disabled-security" --disable-web-security --disable-site-isolation-trials

# macOS
open /Applications/Google\ Chrome.app --args --user-data-dir="/var/tmp/chrome-dev-disabled-security" --disable-web-security --disable-site-isolation-trials

# Linux
google-chrome --user-data-dir="~/chrome-dev-disabled-security" --disable-web-security --disable-site-isolation-trials