REST APIアクセスは、Businessプランで申請すると利用できます。購入時に自動で有効になるのではなく、確認後にワークスペースごとに有効化されます。
HummingDeck API
連携ごとに個別のAPIキーを作成し、必要な権限だけを付与します。
CRMレポート
有効analytics:readcrm:read- 作成日
- 2026年9月2日
- 有効期限
- 2027年9月2日
- 最終使用
- 今日
ルーム公開
有効rooms:readrooms:writedocuments:readdocuments:write- 作成日
- 2026年8月18日
- 有効期限
- 2027年8月18日
- 最終使用
- 昨日
APIアクセスはワークスペースごとに有効化されます。Businessプランのオーナーまたは管理者がこの画面から申請し、承認されると上のパネルが表示されます。
APIの主な用途
実際の業務フローで次の処理が必要な場合は、アクセスを申請してください。
- 生成した資料を自動でアップロードする。
- 社内システムからHTML出力を公開する。
- CRMや営業ワークフローからパーソナライズした共有リンクを作成する。
- ルームをドキュメントとリンク付きで作成し、タブやセクションを整理する。
- 企業やコンタクトを検索または作成する。
- 自動化や連携のためにエンゲージメントイベントを取得する。
手作業でアップロードする資料が少数なら、API連携を維持するより資料ライブラリを使う方が簡単で安全です。
単発の一括処理では、CSVまたは連携済みのClose Smart Viewからパーソナライズした資料リンクを一括生成します。別のシステム内でリンク作成を繰り返す必要がある場合は、APIを使用してください。
アクセスを申請する
ワークスペースを開き、連携を選んで、HummingDeck APIを探します。APIアクセスを申請を選択してください。
申請自体は1クリックで完了します。用途の記載は任意ですが、書いておくとメールでの確認を減らせることがあります。次の情報が役立ちます。
- 自動化したいワークフロー。
- 想定するアップロード数またはリクエスト数。
- 使用するファイル形式。
- 企業、コンタクト、共有、ルーム、閲覧、イベントのうち必要なデータ。
ワークスペースのオーナーと管理者が申請できます。アクセスが有効になったら、メールでお知らせします。
Businessより下位のプランでは、このセクションはロックされた状態で表示され、選択すると利用可能なプランが開きます。
ワークスペースAPIキーを作成する
アクセスが有効になったら、ワークスペースのオーナーまたは管理者がワークスペース、連携、HummingDeck APIの順に開きます。連携先やワークフローごとに、分かりやすい名前を付けたキーを個別に作成してください。1つのワークスペースで同時に有効にできるAPIキーは20個までです。キー名は1〜64文字で指定します。前後の空白と大文字・小文字の違いを除き、有効なキーと同じ名前は使用できません。
キーを作成または置き換えるときは、その連携に必要な権限だけを付与します。書き込み権限には、対応する読み取り権限も含まれます。APIキーの値が表示されるのは一度だけなので、シークレット管理ツールに保存してください。ブラウザ上のコード、HTMLアップロード、公開リポジトリ、共有資料、サポートチケットには貼り付けないでください。
| 権限 | 許可される操作 |
|---|---|
rooms:read | ルーム、タブ、項目、リンク、ラベルを表示します。 |
rooms:write | ルーム、タブ、項目、リンク、ラベルを作成・管理します。 |
plan:read | 相互アクションプランのフェーズとタスクを表示します。 |
plan:write | 相互アクションプランのフェーズとタスクを作成・管理します。 |
analytics:read | エンゲージメント分析、アクティビティ、取得メールを表示します。 |
crm:read | ワークスペースの会社と連絡先を検索します。 |
crm:write | 会社、連絡先、リンクの対象者を作成・更新します。 |
documents:read | ドキュメントを検索し、メタデータを表示します。 |
documents:write | ドキュメントをアップロードし、ドキュメントやURLをルームに追加します。 |
名前と権限を設定する機能が導入される前に作成されたキーは、一覧にLegacy API keyと表示されます。このキーは、置き換えるか無効にするまで、従来どおりすべてのAPI権限を保持します。
各キーは、作成したワークスペースに固定されます。APIリクエストから別のワークスペースを選択したり、この境界を変更したりすることはできません。
各キーの有効期限は作成から1年間です。キーを置き換えると、選択したキーだけがただちに無効になり、新しいAPIキーの値が表示されます。ワークスペース内のほかのキーには影響しません。キーは1つずつ無効にすることもでき、無効にしたキーは元に戻せません。
キーの一覧には、各キーの状態、権限、作成日、有効期限、最終使用日が表示されます。期限切れまたは無効にしたキーの名前と権限を引き継いで、新しいキーを作成することもできます。すべて無効にするを選ぶと、ワークスペース内で有効なすべてのキーがただちに無効になり、元に戻せません。
キーを作成したユーザーがワークスペースのオーナーまたは管理者ではなくなった場合も、そのキーは認証に使用できなくなります。本番環境のキーは、継続して管理するオーナーまたは管理者のアカウントから作成し、連携の担当者が変わったときに置き換えてください。
技術APIリファレンスを開く
アクセス、認証情報、ワークフローについては、このサポート記事を参照してください。現在のエンドポイント、認証、リクエストとレスポンスのスキーマ、エラー、資料のアップロード、共有リンク、企業、コンタクト、ルーム、閲覧、イベント、Webhookについては、公式のHummingDeck APIリファレンスを参照してください。
ブラウザからは100MBまでアップロードできます。APIの資料アップロードエンドポイントは30MBまでです。API経由でアップロードするHTMLにも、手動アップロードと同じ静的コンテンツとアセットの要件が適用されます。
APIで資料を差し替える場合は、.pdf、.pptx、.docxなど、ファイル形式に合った拡張子を付けてください。拡張子がない場合や形式と一致しない場合は、INVALID_FORMATが返されます。