公開APIを使う(トークンの発行)

公開API を使うと、人事システムなど社内のシステムから、パレットLMS のユーザー・コース・受講(割当)を読み書きできます。エンタープライズプラン で使えます。

この操作ができる人

管理者です。エンタープライズプラン以外では「公開APIはエンタープライズプランで利用できます」とだけ出ます。

手順

1. 左のメニューの 「設定」 → 「セキュリティ」 タブを開き、いちばん下の 「公開API(外部システム連携)」 へ移ります。
2. 「ベースURL」(番号1)を 「コピー」 で写します。
3. 「公開APIを有効にしてトークンを発行」(番号2)を押します。

4. 発行されたトークンが 一度だけ 出ます。「コピー」 で写し、連携するシステムに登録します。

使えること

操作	エンドポイント
ユーザーの取得・登録	GET / POST /users
コースの取得	GET /courses
受講(割当)の取得・登録	GET / POST /enrollments

要求の Authorization: Bearer ヘッダーにトークンを付けます。1 分あたり 60 回までで、超えると 429 を返します(Retry-After の秒数だけ待って送り直してください)。

再発行する・やめる

• 「APIトークンを再発行」 で新しいトークンに替えます。今のトークンはすぐ使えなくなります
• 「APIを無効にする」 で止めます。連携システムからの要求はすべて失敗するようになります(データはそのまま残ります)

関連する記事

• SCIMでユーザー・グループを同期する
• 「セキュリティ」タブの見方