Skip to content

APIキー

APIキーはワークスペースに紐づきます。グローバルナビ > ワークスペース設定 > APIキー から管理します。作成・シークレットの取得などはワークスペースオーナーが行います(ワークスペース操作の権限)。

主に 署名付き埋め込み の認証に使います。

管理できること

  • APIキーを作成 し、名前・APIキー・APIシークレットを管理します
  • 一覧では 名前 / APIキー / APIシークレット / 最終使用日(作成日) を確認できます
  • キーのローテーションのため、1つの APIキーに対して複数のシークレットバージョンを発行できます(シークレットを追加
  • シークレットをコピー、シークレットの削除、キーの 名前を変更 / 削除利用ログ / 変更履歴 を参照できます

APIシークレットはサーバーサイドでのみ扱い、紛失時は新規のシークレットバージョンを追加するか、APIキーを作り直してください。

トークン発行

署名付き埋め込み向けのトークン発行 API は、次のとおりです。

  • POST https://api.codatum.com/api/notebook/issueToken
  • トークンのデフォルト有効期限は 1 時間(expires_in デフォルト 3600。最大は 86400)
  • cache_max_age を省略した場合の既定は 86400(最大も 86400)

リクエストフィールドの詳細は 組み込み手順 を参照してください。上限値は 制約と上限値 にも記載しています。

監査ログの対象になります(作成 / 削除 / シークレット取得・作成・削除 / 使用)。