コア API 連携·
コア API 連携
niyase.core でコアデータ(社員・部署・スペース)を承認スコープ付きで読み取る。
プラグインは独自テーブルで完結させるのが原則ですが、コアデータの参照が必要な場合は
useNiyase().core を使います(直接 DB 参照・任意のサーバへの fetch は不可)。
niyase.core API
const niyase = useNiyase();
await niyase.core.workspace(); // 現在のスペース(最小フィールド)
await niyase.core.employees(); // { items, total } — マスク済みの最小情報
await niyase.core.employee(id);
await niyase.core.departments(); // { items }
niyase.core.grantedScopes; // 有効化時に承認されたスコープ(UI 出し分けに)
内部的にはアプリ内プロキシ /nplg-core/v1/:pluginId/* を叩きます。
返るのは最小 projection(例: 社員は氏名・メール・在籍状態のみ。マイナンバー等は返しません)。
承認スコープ(grantedScopes)
コアデータは、スペースのオーナーが有効化時に承認したスコープの範囲でのみ読めます。
| スコープ | 内容 |
|---|---|
core:workspace:read | スペース情報 |
core:employee:read | 社員一覧・個別 |
core:department:read | 部署 |
未承認の機能はサーバ側が 403 SCOPE_DENIED を返します。
niyase.core.grantedScopes を見れば、403 を待たずに UI を出し分けできます。
if (niyase.core.grantedScopes.includes("core:employee:read")) {
// 担当者選択 UI を出す
}
エラーの扱い
ブリッジのエラーは安定したコード集合(NiyaseErrorCode)に正規化されます
(SCOPE_DENIED / NOT_FOUND / VALIDATION / OFFLINE / MAINTENANCE 等)。
status と code で分岐し、ユーザーに適切なフィードバックを返してください。