APIアクセスとリファレンス

REST APIアクセスは、Businessプランで申請すると利用できます。購入時に自動で有効になるのではなく、確認後にワークスペースごとに有効化されます。

APIの主な用途

実際の業務フローで次の処理が必要な場合は、アクセスを申請してください。

• 生成した資料を自動でアップロードする。
• 社内システムからHTML出力を公開する。
• CRMや営業ワークフローからパーソナライズした共有リンクを作成する。
• 企業やコンタクトを検索または作成する。
• 自動化や連携のためにエンゲージメントイベントを取得する。

手作業でアップロードする資料が少数なら、API連携を維持するより資料ライブラリを使う方が簡単で安全です。

単発の一括処理では、CSVまたは連携済みのClose Smart Viewからパーソナライズした資料リンクを一括生成します。別のシステム内でリンク作成を繰り返す必要がある場合は、APIを使用してください。

アクセスを申請する

ワークスペースを開き、連携を選んで、HummingDeck APIを探します。APIアクセスを申請を選択してください。

申請自体は1クリックで完了します。用途の記載は任意ですが、書いておくとメールでの確認を減らせることがあります。次の情報が役立ちます。

• 自動化したいワークフロー。
• 想定するアップロード数またはリクエスト数。
• 使用するファイル形式。
• 企業、コンタクト、共有、閲覧、イベントのうち必要なデータ。

ワークスペースのオーナーと管理者が申請できます。アクセスが有効になったら、メールでお知らせします。

Businessより下位のプランでは、このセクションはロックされた状態で表示され、選択すると利用可能なプランが開きます。

ワークスペーストークンを作成する

アクセスが有効になったら、ワークスペースのオーナーがワークスペース、連携、HummingDeck APIの順に開きます。管理者もアクセスを申請できますが、トークンを作成できるのはオーナーだけです。

トークンが表示されるのは一度だけです。シークレット管理ツールに保存してください。ブラウザ上のコード、HTMLアップロード、公開リポジトリ、共有資料、サポートチケットには貼り付けないでください。

新しいトークンを作成すると、以前のトークンはただちに置き換えられます。無効にしたトークンは元に戻せません。ワークスペーストークンの有効期限は1年間です。

技術APIリファレンスを開く

アクセス、認証情報、ワークフローについては、このサポート記事を参照してください。現在のエンドポイント、認証、リクエストとレスポンスのスキーマ、エラー、資料のアップロード、共有リンク、企業、コンタクト、閲覧、イベント、Webhookについては、公式のHummingDeck APIリファレンスを参照してください。

ブラウザからは100MBまでアップロードできます。APIの資料アップロードエンドポイントは30MBまでです。API経由でアップロードするHTMLにも、手動アップロードと同じ静的コンテンツとアセットの要件が適用されます。