サポートページ Benchmark Email RESTful APIとは?
Benchmark EmailではAPIを無料で公開しておりますので、連携開発を行って頂くことが可能です。
APIを使用すればBenchmark Emailにログインせずともデータを扱うことができます。
利用方法については以下のFAQ(日本語)をご参照ください。
FAQ:Benchmark Email の RESTful API を利用する方法は?
本ページでは、RESTful APIの概要をご説明します。
RESTとは?
RESTはREpresentational State Transferの略になります。
RESTはHTTPを元にした制約とプロパティを定義するアーキテクチャスタイルです。HTTPが利用された際、最も一般的で利用可能なオペレーションはGET、POST、PATCH、DELETEと事前に定義されたCRUD HTTPメソッドです。
全てのユーザーはBenchmark EmailのRESTful APIを用いて外部サービス連携を構築する事ができます。これらの連携によりリストの詳細入手、リストのアップロード、プラットフォームからBenchmark Emailアカウントへのデータ移行やメールマガジンのアップロードも可能となります。Benchmark EmailのRESTfulページで利用できるHTTPメソッドは次の通りです。
GET | POST | PATCH | DELETE |
GETメソッドはリソースの値を取得する際に用いられます。
GETリクエストは安全かつ同様のパラメーターで何度繰り返しても結果が不変的(冪等性)であることが求められます。 |
POSTリクエストは新しいリソースを作成する際に用いられます。POSTは新しいデータを書き込みする際によく利用されますが、データを更新するのにも利用する事が出来ます。 | URLにてデータの特定フィールドのみを更新できます。PATCHリクエストもGETリクエスト同様、冪等的になります。 | データを削除するリクエストですが、必ずしも直後に削除反映ということではありません。リクエストは長期間、又は事前に送ることも可能です。 |
API構築のための環境が整っているのであれば、ご活用頂くことを推奨します。そうでない場合には専門知識を持つWeb開発者にご依頼が必要になります。
上記のHTTPメソッドやリクエストはメソッドと併せてページの左側にあるカテゴリー内に記載されてます。
メソッドを選択すると、同じ内容の詳細がパラメーターと併せて投入(追加)され、ページの右側にサンプルコードが提供されます。 コードを入手する際に好きな言語をドロップダウンより選択、またはキーワード検索もご利用可能です。 コードのテスト及び実行をするには右上にある「Run in Postman」ボタンをデベロッパーが利用できます。 詳細に関しては、以下のリンク(英語)をご覧ください。
リンク: Benchmark Email RESTful API
登録を完了させるには、認証メールのご確認をお願いします。