署名付き埋め込みの設定方法

外部サービスにノートブックをシームレスに統合

設定方法

署名付き埋め込みの準備

• APIキーとAPIシークレットの準備

  • ワークスペース設定を開き、APIキーメニューをクリックします。

  • APIキーを追加ボタンをクリックして新しいAPIキーを作成します。

  • APIキーとAPIシークレット（後でAPIコールに使用します）をメモしておきます。

• ノートブックを開く

  • 共有したいノートブックを開きます。

  • ヘッダーの共有ボタンをクリックし、署名付き埋め込みタブを選択します。

• 署名付き埋め込みの公開

  • 公開対象のページの選択や、公開時のオプションを設定します。

  • 公開ボタンをクリックします。

• 署名付き埋め込みの設定

  • 権限を付与するAPIキーセクションで使用するAPIキーを追加します。

  • サーバーサイドでのトークン発行時に値を指定するパラメータを、サーバーサイドパラメータセクションで設定します。

サーバーからトークンを発行する

• トークンを発行するには以下のAPIを使用します

  • APIを呼び出すために必要な引数は セットアップガイドタブで確認できます。

  • APIシークレットが外部に漏れないようにするため、サーバーサイドでAPIコールを実行してください。

  • ユーザーセッションごとにトークンを発行し、再利用しないでください（デフォルトでは1時間後に期限切れになります）。

post

本文

application/json

api_keystring · 最小: 24 · 最大: 24必須

API Key. Can be issued from 'Workspace settings > API Keys'

Example: 6729a28bc7100424ad4e2e5d

api_secretstring · 最小: 32 · 最大: 32必須

API Secret. Generated when issuing 'API Key'

Example: c711defdff5f4e3e8e53d4f408579b9a

integration_idstring · 最小: 24 · 最大: 24必須

Integration ID. Can be obtained from the signed embed settings

Example: 671ef14b0d08cf6c657df7da

page_idstring · 最小: 24 · 最大: 24必須

Page ID to be displayed in the notebook. Can be obtained from the signed embed settings

Example: 671ecbbf2990c63fea3b3a26

token_user_idstring · 最小: 1必須

Specify the user ID within the application where the notebook is embedded. Ensure that the token can uniquely identify the token user for security reason.

expires_ininteger · 最小: 1 · 最大: 86400オプション

Token expiration time in seconds. Default is 3600 seconds (1 hour)

Example: 3600

cache_max_ageinteger · 最大: 86400オプション

Cache max age in seconds. Default is 86400 (24 hours)

Example: 86400

レスポンス

200

Generated token

application/json

tokenstring必須Example: (Generated-token)

400

Bad request

application/json

401

Unauthorized

application/json

post

/api/notebook/issueToken

HTTPcURLJavaScriptPython

POST /api/notebook/issueToken HTTP/1.1
Host: api.codatum.com
Content-Type: application/json
Accept: */*
Content-Length: 313

{
  "api_key": "6729a28bc7100424ad4e2e5d",
  "api_secret": "c711defdff5f4e3e8e53d4f408579b9a",
  "integration_id": "671ef14b0d08cf6c657df7da",
  "page_id": "671ecbbf2990c63fea3b3a26",
  "token_user_id": "text",
  "params": [
    {
      "param_id": "6722c7061b02448a4056d84d",
      "param_value": "\"Hello world\""
    }
  ],
  "expires_in": 3600,
  "cache_max_age": 86400
}

{
  "token": "(Generated-token)"
}

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

• Codatum Embed SDK を使ってフロントエンドに組み込みます

  • 組み込みに必要な embedUrl は セットアップガイドタブで確認できます

  • tokenProvider には、サーバーサイドでトークンを発行するAPIを指定します

  • その他の設定可能な全オプションに関しては、SDKのREADMEを参照してください。

付録

よくある質問

トークン発行時に "Missing param: xxx" エラーが出る場合

• トークン発行時には、全てのサーバーサイドパラメータをリクエスト内に含める必要があります

• "xxx" というパラメータIDのパラメータがリクエスト内に含まれていない場合、このエラーが発生します

クライアントサイドパラメータの送信時に "The following parameters must be set by the server" エラーが出る

• クライアントサイドパラメータの送信時にサーバーサイドパラメータを変更しようとしています

• サーバーサイドパラメータを変更するためには、新しいトークン発行が必要です

クライアントサイドパラメータの送信時にパラメータが変更されない場合

• 送信したパラメータがサーバーサイドパラメータとして指定されていないか確認してください

• param_valueが正しいJSON文字列形式か確認してください

• param_idが実在するパラメータIDと一致しているか確認してください