メインコンテンツまでスキップ

🔗 外部学習資源 JavaScript SDK

外部学習資源 SDK

本書はエリスの外部学習資源の開発ガイドラインを提供します。

その他の質問については、エリスまでお問い合わせください。

SDKのインストールと初期化

外部学習資源JavaScript SDKをnpmパッケージとしてインストールしてください。このパッケージはWeb環境で使用可能です。

# npm
npm install @eliceio/content-sdk --save

# yarn
yarn add @eliceio/content-sdk

クラス

インストールしたSDKが提供するクラスEliceContentsを使用すると、外部学習資源の開発に必要なメソッドとプロパティを使用できます。

import { EliceContents } from '@eliceio/content-sdk';

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

初期化時に提供するオプションは以下の通りです:

名前タイプ説明
baseUrlstringEliceプラットフォームAPIサーバーのbase URLです。CORSポリシーはelice.ioオリジンへのリクエストのみを許可します。したがって、ローカル環境でテストする場合は、プロキシサーバーを構成するか、ブラウザの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