API連携

API連携仕様書+サンプルプログラム

※仕様詳細は下記仕様書を参照ください。

API連携(全般)

 CRMやSFAなどの期間システムから「配配メール」へ顧客レコードを一括登録・削除、
 または「配配メール」からの配信結果の取得を行うことが可能です。
 本機能はオプション申し込み頂いた上で、お客様側で2種類のプログラムのご用意が必要です。
 
 ※オプション契約だけではご活用頂くことができません。御注意ください。 
 ※詳細は「【配配メール】API連携仕様書 API連携(CSV) / API連携(取得系)」をご参照ください。

APIトークンの生成

API連携を利用するためには各種設定画面にてAPIトークンを生成・設定する必要があります。

1. 各種設定>各種設定メニュー>基本設定 画面にて「生成」をクリックします。
2.  画面下部までスクロールして「変更」ボタンをクリックします 。

生成後、「再生成」「削除」も可能です

接続許可IPアドレスの設定

 接続を許可するIPアドレスを入力してください(改行区切りで複数設定することができます)
 ※レンジ指定やネットワークアドレスのみの指定はできません。

 1:「各種設定」>「システム設定」>「基本設定」の順にクリックします。
 2:「API IPアドレス制限」で[する]にチェック⇒接続を許可するIPアドレスを入力します。
 3: 画面下部までスクロールして「変更」ボタンをクリックします。

API実行回数制限

API連携機能は1日当たりの利用回数に制限を設けております。

回数制限

CSV一括登録・削除・状態変更:240回/日(※API毎)
分析、数値データ取得:240回/日(※API毎)
※いずれも専用サーバープランをご契約頂いた場合の制限は「86,400回/日」となります


・制限回数を超えた場合は エラーになります。(エラーコード:429)
・回数カウントは毎日夜 0:00にリセットされます。
 制限回数を超えた場合、リセットされるまで利用することができません。
※ 回数カウントについて:エラーを除くすべてのAPIの利用回数が対象となります。

API連携(CSV一括登録・削除・状態変更)

CSVデータを連携し一括登録・削除(除外)、または配信状態の変更を実行するAPIです。

APIリスト

・CSV 一括登録・削除・状態変更 API

処理結果の確認

 API連携機能を利用した処理結果を配配メール画面の「一括登録・削除の処理結果」
 にて確認できます。

 ⇒「レポート」タブをクリックし、「一括登録・削除の処理結果」をクリックします。

処理状況

完了 登録・削除が完了した処理です。
処理中 現在、登録・削除中の処理です。
処理待ち 現在、登録・削除前の処理です。

処理結果

成功 登録・削除に成功したレコードです。
失敗 何らかの理由で登録/削除に失敗したレコードです。
その他 一括登録の際、既に登録済みのレコードです。

マーク をクリックすると、該当データのCSVファイルをダウンロードできます。
処理結果を確認できるのは、過去10日間の一括処理です

注意事項

・利用回数 240回/日(※API毎)
 ※ API接続ごとに1回とカウントされます。
 ※専用サーバープランをご契約頂いた場合の制限は「86,400回/日」となります
 
・連携するCSVファイルの1行目には、必ずデータベース項目名(「メールアドレス」など)の
 記述が必要です。
※メールアドレス項目に該当する項目名は必須です。
※配配メールに設定してあるデータベース項目名と同一にしてください。
 名称が異なる項目は登録・削除ができません。項目の順番は異なっていても問題ありません。

API連携(取得系)

 効果測定等の情報をCSVファイルで取得するためのオプションとなります。

APIリスト

API名称詳細
開封メール取得開封したHTMLメールのデータを取得する
クリックメール取得URLをクリックしたメールのデータを取得する
配信停止/禁止顧客一覧取得配信停止・配信禁止の顧客の一覧を取得する
来訪回数取得指定した日付の来訪回数を取得する
※Bridgeプランのみ利用可能
フォーム一覧取得フォームの一覧を取得する
※Bridgeプランのみ利用可能
フォーム回答一覧取得フォームの回答一覧を取得する
※Bridgeプランのみ利用可能
メール一覧取得指定日のメール一覧を取得する
顧客閲覧URL生成指定アドレスの顧客閲覧画面のURLを生成する
グループ名・ステップメール名一覧取得グループ名・ステップメールプラン名の一覧を取得する
顧客データベース項目一覧取得顧客データベース項目のIDと項目名を取得する
反応者一覧取得指定日の効果測定結果・反応者の顧客情報を取得する

※本機能はオプションに申込し、お客様側でプログラムをご用意頂く必要がございまます。

注意事項

  ・利用回数 240回/日(※API毎)
 ※ API接続ごとに1回とカウントされます。
 ※専用サーバープランをご契約頂いた場合の制限は「86,400回/日」となります
 ※反応者一覧取得 API については「効果測定種別」1種類毎に「240回/日」となります

 
 ・「来訪回数取得API」「フォーム一覧取得API」「フォーム回答一覧取得API」は Bridgeプランのアカウントのみとなります。
 ※ Bridgeプラン以外の方が実行した場合、エラーとなります。


接続用パスワードの設定(旧:外部システム連携用)

※旧:外部システム連携の利用者のみ表示される項目です
※API連携を利用する場合、接続用パスワード設定はありません(認証はAPIトークンで行います)

 
 外部連携の認証に必要なパスワードを「各種設定」内の「基本設定」より設定していきます。
 ※ログインした後に「各種設定」が表示されてない場合は管理担当者様に御確認ください

 1:「各種設定」>「システム設定」>「基本設定」の順にクリックします。
 
 2:「APIパスワード」で「接続用パスワードを変更する」をチェックします。

 3: 画面下部までスクロールして「変更」ボタンをクリックします。
 

※パスワードは英字(小文字)、英字(大文字)、数字、記号のうち2種類以上を使い、8~24文字以下で入力

※旧:外部システム連携とAPI連携は仕様が異なります。詳細は外部システム連携仕様書を参照ください。

配配メールコネクタ(別オプション)


外部の基幹システムと配配メールを繋ぎ、
基幹システムで管理している顧客情報を自動同期できるオプションです。

「配配メールコネクタ」を活用すると、自社内でのAPI開発が不要になり、
開発コスト削減、配信リスト登録の効率化が可能になります。



■下記の基幹システムとの連携オプションをご用意しております。


サービス・製品

見込み顧客を可視化して、メールマーケティングの勝ちパターンを見つけよう!!