ver.1サポートサイト

THANKS配信(PHP)

最終更新日:2019年07月31日

THANKSメールの配信設定をするサンプルプログラムです。
本サンプルプログラムは外部呼出し(スパイラル以外のサーバから動作させる場合)と内部呼出し(スパイラル内部で動作させる場合)と分けて記載をしています。
利用する用途によって使用するサンプルプログラムの使い分けを行ってください。
※外部呼出しに利用するサンプルプログラムにはスパイラル内のWebコンポーネントで使用できない関数などが含まれる場合がありますのでご注意ください。
使用できないPHPの関数について、PHP利用時の注意事項をご覧ください。
※内部呼出しを利用する場合はアカウント内APIの設定を「ON」に変更する必要があります。

関連するページ
スパイラルAPIの使い方
APIリファレンス:サンクスメール配信
アカウント内API

外部呼出しを利用する場合

<?php
// [ 概要 ]
// スパイラルのAPIを使ったサンプルプログラムです。
// [ サンプルで行う事 ]
// - Thanksメールを送信する
// このファイルはUTF8で保存してください。
// [サンプルを動かすための準備]
// 0. PHPにcurlライブラリが組み込まれている必要があります。
// 参考:http://www.php.net/manual/ja/intro.curl.php
// 1. スパイラルの操作画面の「管理グループ」「API設定」で、トークンを発行します。
// 下記、$TOKEN, $SECRET へ設定します。
// 2. スパイラルの操作画面の「DBグループ」「通常DB管理」で、以下のようなDBを発行します。
// DBタイトル:
// api_sample
// フィールド:
// No1 フィールド名  :メールアドレス
// フィールドタイプ:メールアドレス(大・小文字を無視)
// 差替えキーワード:mail
// No2 フィールド名  :テキストエリア
// フィールドタイプ:テキストエリア(256bytes)
// 差替えキーワード:text
// 3. THANKS配信登録で使うため、「Webグループ」「フォーム管理」で、登録フォームを作成します。
// 実際にフォームは使いませんのでダミーの設定ということになります。
// 4. THANKS配信登録で使うため、「メールグループ」「リスト作成」で、
// 適当な設定でリストを追加します。
// 5. THANKS配信登録で使うため、「メールグループ」「封筒製作:直接入力」で、
// 封筒を追加します。どの封筒形式でもかまいません。
// 6. スパイラルの操作画面の「メールグループ」「THANKS配信登録」で、
// 上記で作成した登録フォームに対して配信設定を追加します。
// サービス用のURL (ロケータから取得できます)
$APIURL = "https://xxxxx.smp.ne.jp/api/service";
// スパイラルの操作画面で発行したトークンを設定します。
$TOKEN = "XXXXXXXXXX";
$SECRET = "YYYYYYYYYY";
// -----------------------------------------------------------------------------
// サンキューメール送信
// -----------------------------------------------------------------------------
// API用のHTTPヘッダ
$api_headers = array(
"X-SPIRAL-API: deliver_thanks/send/request",
"Content-Type: application/json; charset=UTF-8",
);
// 送信するJSONデータを作成
$parameters = array();
$parameters["spiral_api_token"] = $TOKEN;
$parameters["rule_id"] = "XXXXX"; //サンキューメールの配信ルールID
$parameters["id"] = "YYYYY"; //レコードのid
$parameters["passkey"] = time();
// 署名を付けます
$key = $parameters["spiral_api_token"] . "&" . $parameters["passkey"];
$parameters["signature"] = hash_hmac('sha1', $key, $SECRET, false);
// 送信用のJSONデータを作成します。
$json = json_encode($parameters);
echo "===> deliver_thanks/send\n";
// curlライブラリを使って送信します。
$curl = curl_init($APIURL);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_POST , true);
curl_setopt($curl, CURLOPT_POSTFIELDS , $json);
curl_setopt($curl, CURLOPT_HTTPHEADER , $api_headers);
curl_exec($curl);
// エラーがあればエラー内容を表示
if (curl_errno($curl)) echo curl_error($curl);
$response = curl_multi_getcontent($curl);
curl_close($curl);
// 画面に表示
// 配列にしたい時は json_decode($response, true); とします。
//echo "$response\n\n";
print_r(json_decode($response, true));
?>

内部呼出しを利用する場合

<?php
//
//[ 概要 ]
//スパイラルのAPIを使ったサンプルプログラムです。
//[ サンプルで行う事 ]
//- Thanksメールを送信する
//このファイルはUTF8で保存してください。
//[サンプルを動かすための準備]
//1. スパイラルの操作画面の「DBグループ」「通常DB管理」で、以下のようなDBを発行します。
// DBタイトル:
// api_sample
// フィールド:
// No1 フィールド名  :メールアドレス
// フィールドタイプ:メールアドレス(大・小文字を無視)
// 差替えキーワード:mail
// No2 フィールド名  :テキストエリア
// フィールドタイプ:テキストエリア(256bytes)
// 差替えキーワード:text
//2. THANKS配信登録で使うため、「Webグループ」「フォーム管理」で、登録フォームを作成します。
// 実際にフォームは使いませんのでダミーの設定ということになります。
//3. THANKS配信登録で使うため、「メールグループ」「リスト作成」で、
// 適当な設定でリストを追加します。
//4. THANKS配信登録で使うため、「メールグループ」「封筒製作:直接入力」で、
// 封筒を追加します。どの封筒形式でもかまいません。
//5. スパイラルの操作画面の「メールグループ」「THANKS配信登録」で、
// 上記で作成した登録フォームに対して配信設定を追加します。
// -----------------------------------------------------------------------------
// サンキューメール送信
// -----------------------------------------------------------------------------
// APIコミュニケータをセット
$api_communicator = $SPIRAL->getSpiralApiCommunicator();
// リクエストパラメータのセット
$request = new SpiralApiRequest();
$request->put("rule_id" , xxx); //サンキューメールの配信ルールID
$request->put("id" , xxxxx); //レコードのid
// スパイラルAPIサーバへリクエストを送信
$response = $api_communicator->request("deliver_thanks", "send", $request);
// レスポンスの取得
if($response->get("code") == 0)
{
echo "<p>deliver_thanks/send 正常終了。(code:".$response->get("code").")</p>";
}
else
{
echo "<p>deliver_thanks/send エラーが発生しました。(code:".$response->get("code").")</p>";
}
print_r(phpversion());
print_r($response);
echo "<br><br>";
?>