サポートページ aero-right restful api

Benchmark Email RESTful APIとは?

  素晴らしいテクノロジーがどんどん開発されている今日、世界は確実にオートメーション化に向かっています。APIを使用すればBenchmark Emailにログインせずともデータを扱うことができます。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 利用方法については以下のFAQ（日本語）をご参照ください。 FAQ：Benchmark Email の RESTful API を利用する方法は？     ＞＞「API/連携アプリ」のまとめページに戻る

API 10月 3, 2020

Benchmark Email の RESTful API を利用する方法は？

RESTful APIのご利用にはBenchmark EmailのAPIキーが必要になります。利用するにはBenchmark Emailアカウントが必要です。無料トライアルプランでもアクセス頂けます。 Benchmark EmailのAPIキーを取得する方法 Benchmark EmailのAPIキーは、セキュリティトークンであると同時にアカウントのユニークIDでもあります。APIキーは、他のサービスとの連携やワークフローの自動化に使用することが可能です。アカウントのデータへのアクセスを許可していない限り、APIキー公開したり共有したりしてはいけません。APIキーを取得するには、以下の手順に従ってください。 1. Benchmark Emailアカウントへログイン 2. 画面右上のアカウント名をクリックし、「連携」を選択 3. 画面左手のメニューからAPI キーをクリック 4. Benchmark Email API キーが表示されますので、こちらをコピーしてご利用ください。 注意：APIキーはアカウントによって異なります。「あなたのAPIキーは」の下に表示されたものがAPIキーとなります。 RESTful APIの入手 以下のURLより最新のRESTful APIを入手できます。 https://developer.benchmarkemail.com/?version=latest ＊現在のバージョンはPOSTMAN環境でのご利用となります。 APIを用いた連携構築について、連携可能範囲に関するご質問、連携開発中に発生したエラーに関するご相談をこちらで受け付けております。     ＞＞「API/連携アプリ」のまとめページに戻る

API 連携機能 5月 20, 2021

API連携を使って何ができますか？

Benchmark EmailではRestful APIを公開し、ユーザーが自由に連携構築を行えるようにしています。 APIを使って自社サービスやデータベースとBenchmark Emailアカウントを連携させ、自社サービス内でBenchmark Emailの各機能をお使いいただくことが可能となります。 API連携でできることについては、大きく分けて以下4つのカテゴリに分類されます。 顧客リスト関連 メール作成・配信関連 レポート関連 セキュリティー関連 1. 顧客リスト関連 社内で使用しているシステムで管理している顧客情報を、Benchmark Emailのアカウントに連携させることができます。コンタクトリストの作成、顧客情報のインポート、配信停止の管理、リストの更新、リストの出力などが可能です。 2. メール作成・配信関連 お使いのシステム上で、メルマガの作成、編集、コピー、配信設定、テストメールの送信が可能となります。 3. レポート関連 Benchmark Emailの「メールレポート」で確認できる全てのデータ（開封、エラー、クリックなど）を出力・閲覧することが可能です。 4. セキュリティー関連 トークンの作成・管理が可能です。 セキュリティートークンを使用する事で、Benchmark Emailアカウントにログインせずに上記の操作を行うことが可能となります。 構築にあたり、現在検討中の連携内容が可能か問い合わせたい場合は、こちらよりサポートへご連絡下さいませ。ただし具体的な構築につきましてはサポートを行っておりませんので、開発ご担当者様にご確認ください。 APIを利用する方法はこちらをご覧ください。 FAQ：Benchmark Email の RESTful API を利用する方法は？    構築・開発不要でご利用頂ける連携アプリも、いくつかご用意しています。 最新の連携アプリ一覧はこちらをご覧ください。   ＞＞「API/連携アプリ」のまとめページに戻る

API 連携機能 4月 14, 2021