Codatum Docs

Appearance

組み込み手順 ​

署名付き埋め込みを外部アプリに組み込む手順です。機能の概要は 署名付き埋め込み を参照してください。

準備 ​

  1. グローバルナビ > ワークスペース設定 > APIキー を開き、APIキー を作成します。APIキーと APIシークレットを控えておきます
  2. ノートブック画面の 共有 > 署名付き埋め込み から公開します
  3. 設定画面で 権限を付与するAPIキー に、利用する APIキーを追加します
  4. テナントごとのデータ分離や埋め込み元ドメインの制限が必要な場合は、サーバーサイドパラメータ や 許可されたオリジン を設定します

設定画面の セットアップガイド で、トークン発行用のリクエスト例と埋め込み URL を確認できます。

トークンの発行 ​

サーバー側で次の API を呼び出します。APIシークレットはサーバーサイドのみで扱い、フロントエンドに含めないでください。同一のユーザー（token_user_id）かつ同一の固定値・同一の audit_note の場合、有効期限内のトークンを再利用できます。いずれかが変わる場合は再発行してください。

OpenAPI Spec は トークン発行 API を参照してください。JSON の URL は次のとおりです。

text
https://api.codatum.com/api/notebook/spec.json

リクエスト ​

フィールド必須説明
api_key必須APIキー
api_secret必須APIシークレット
integration_id必須署名付き埋め込みの ID。設定画面で確認できます
page_id必須表示するページの ID。設定画面で確認できます
token_user_id必須埋め込み先アプリ内のユーザーを一意に識別する ID。監査や実行結果のアクセス制御に使います。Codatum のワークスペース権限には影響しません
params必須サーバーサイドパラメータの配列。各要素は param_id と param_value（JSON 文字列化した値）です。設定したサーバーサイドパラメータはすべて含める必要があります。サーバーサイドパラメータを使わない場合も、空配列 [] を送ってください
expires_in任意トークンの有効期限（秒）。既定は 3600、最大は 86400 です
cache_max_age任意キャッシュの最大有効期間（秒）。既定は 86400、最大は 86400 です。0 はキャッシュ無効です
audit_note任意このトークンで行われた操作の監査ログに記録される任意の文字列。Codatum は内容を解釈せず、動作には影響しません。トークンに含まれるため、秘匿情報は入れないでください。最大 256 文字です（制約と上限値）

レスポンス ​

フィールド説明
token発行されたトークン

フロントエンドへの組み込み ​

フロントエンドへの組み込みには Codatum Embed SDK を使います。パッケージは次のとおりです。

埋め込み URL（embedUrl）は設定画面の セットアップガイド で確認できます。インストール方法・オプション・イベントの詳細は各パッケージの README を参照してください。

ts
import { createEmbed } from '@codatum/embed';

const embed = createEmbed({
  container: '#dashboard',
  embedUrl: 'https://app.codatum.com/protected/workspace/<wsId>/notebook/<integrationId>',
  tokenProvider: async () => {
    const res = await fetch('/api/codatum/token', { method: 'POST' });
    const data = await res.json();
    return { token: data.token };
  },
});
await embed.init();

tokenProvider は、自社サーバーでトークンを発行して返すコールバックです。初期化時・再読み込み時・トークン期限前の更新時に呼ばれます。

組み込み時のよくある質問は FAQ を参照してください。

© Codatum Inc.