FeaturesConsumer SDKインストール

Consumer SDKのインストール

Consumer SDKはOrizmのデータにアクセスするためのJavaScriptライブラリです。WebサイトやアプリケーションからOrizmのコンテンツを取得する際に使用します。

Consumer SDKとは

Consumer SDKは @orizm/consumer-sdk というパッケージ名でNPMレジストリから配布されているJavaScriptライブラリです。

導入方法

Consumer SDKは以下のコマンドでインストールできます。

pnpm add @orizm/consumer-sdk @orizm/common

クライアントのセットアップ

Consumer SDKを使用するには、以下の手順でセットアップを行います。

Consumer API Keyの取得

Consumer API KeyはOrizmのコンテンツにアクセスするための認証キーです。

  1. 開発者コンソールにログインしてプロジェクトを開く
  2. SettingsメニューからConsumer Keysを選択
  3. 「新規作成」ボタンをクリックして新しいConsumer Keyを作成
  4. Description of the keyを入力し、必要に応じてAllow reading draft content with this keyオプションを有効にする
    • このオプションを有効にすると、このキーで下書き状態のコンテンツにアクセスできます
  5. Generateボタンをクリックする

環境変数の設定

Consumer SDKの設定は環境変数で行います。

環境変数として以下の内容を記述してください。 <プロジェクト名> や <取得したConsumer API Key> はそれぞれ取得した値に置き換えてください。

.env
NEXT_PUBLIC_ORIZM_BASE_URL=https://app.orizm.com
NEXT_PUBLIC_ORIZM_PROJECT=<プロジェクト名>
ORIZM_CONSUMER_KEY=<取得したConsumer API Key>

クライアントコードの生成

Consumer SDKを使用するには、プロジェクトのスキーマ情報に基づいたクライアントコードを生成する必要があります。

クライアントの初期化と使用

生成されたクライアントを使用して、Orizmのデータにアクセスできるようになります。

import { OrizmClient } from "@repo/orizm/client";
 
// クライアントの初期化
const serverSideCmsClient = new OrizmClient({
  orizmRoot: process.env.NEXT_PUBLIC_ORIZM_BASE_URL,
  project: process.env.NEXT_PUBLIC_ORIZM_PROJECT,
  consumerKey: process.env.ORIZM_CONSUMER_KEY,
});
 
// データの取得例
async function fetchArticles() {
  return await serverSideCmsClient.tables.article.list({});
}

設定オプション

下書きコンテンツへのアクセス

下書きコンテンツにアクセスする場合は、以下の条件を満たす必要があります：

  1. Consumer API Key作成時にAllow reading draft content with this keyオプションを有効にする
  2. APIリクエスト時にdraftパラメータを指定する
const draftArticles = await client.tables.article.list({ draft: true });

関連ドキュメント

CLICLI