Benchmark EmailのAPIについて

Benchmark EmailのAPIを利用すると、既存のツールとアカウントを連携させることができ、作業の自動化やデータの同期が簡単になります。これにより、手作業を減らし、業務の効率化を図りながら、メールマーケティングをスムーズに管理することが可能です。


👉  開発者向けの詳しいドキュメントはこちら(英語)



Benchmark EmailのAPIについて


Benchmark EmailのAPIを利用すると、CRMやECサイト、その他のアプリケーションなど外部システムとアカウントを連携することができます。


APIを利用することで、コンタクトの追加や更新、リストの検索・管理、データの同期を手作業でのインポートなしに自動で行えます。また、「アカウント設定 > APIキー」からAPIキーを作成・管理でき、アクセス権限も自由に設定可能です。


APIキー制限

セキュリティと管理のしやすさを保つため、作成できるAPIキーの数には上限が設けられています。

  • 無料トライアルアカウントでの APIキーの上限は2つ
  • 有料プランでのAPIキーの上限は10個

上限に達した場合、新しいAPIキーの作成には作成済みのAPIキーの無効化が必要となります。

詳細な技術情報や利用シナリオ、エンドポイントの一覧については、こちら(英語)をご覧ください。



APIキーの作成と管理


APIキーは簡単に作成でき、外部ツールがアカウントとどのように連携するかを柔軟に管理できます。

APIキーの作成について:

  1. アカウント設定ページに進み、APIキーをクリック。
  2. 「+APIキーを作成」をクリック。

  3. キーネームを入力。
  4. これは内部利用のためのもので、後からキーを識別しやすくするために使用されます。

    「リソースの種類」と「アクセスレベル」を選択して、権限を設定してください。

リソース

アクセスレベル

    • コンタクト
    • メール
    • レポート
    • ドメイン
    • アクセスなし
    • 読み込みのみ
    • 読み込みと書き込み (レポートとドメインに対しては不可)

  1. 有効期限を設定
  2. 「APIキーの作成」をクリック

作成したAPIキーの管理について:

  • 編集するAPIキー横の三点リーダ をクリック
  • 以下のことが可能です:
    • APIキーの再生成
    • APIキーの無効化
    • APIキーの削除

APIキーを整理して管理し、必要最小限の権限に制限することで、セキュリティと管理性を高めることができます。


APIを使用するメリット


  • 既存のシステムと連携し、コンタクト情報を自動で同期することで、手動でのインポート作業を削減できます
  • 各プラットフォーム間でデータをリアルタイムに最新の状態に保つことができます
  • 業務内容に合わせたカスタムワークフローを構築できます
  • メール配信のパフォーマンスデータを、自社のダッシュボードやレポートツールに取り込めます
  • Benchmarkにログインせずに、外部からコンタクトやリストの管理が可能です


よくあるご質問と回答

'

APIの仕様は誰に適していますか?

APIの利用に慣れている方や、開発者・連携ツールを利用できる環境にある方に適しています。


APIキーはどこにありますか?

アカウント設定 > APIキーにてAPIキーの作成と管理ができます。


APIで何ができますか?

コンタクトの同期やリスト管理、メールデータの取得が可能で、日常的に利用している他のツールとも連携できます。