APIメソッドごとのサンプルコードまとめ　Email Job

この記事では Email Job のメソッドごとに、サンプルコードをまとめています。
SPIRAL ver.2 でAPIを使用する時の参考になれば幸いです。

APIメソッドごとのサンプルコードまとめ　Email Job

はじめに

この記事で紹介するサンプルコードでは、共通のcurl送信用モジュールを使用しています。
そのため、必ず下記のモジュールを記載するようにしてください。

※それぞれのメソッドのサンプルコードに「共通モジュール」の記載箇所が明記されていますので、そちらにこのモジュールを貼り付けてご使用ください。
※共通モジュールなので、APIメソッドを複数回実行する場合でも1回だけ記載すれば大丈夫です。
※APIメソッドを複数回実行する場合は、サンプルコードの「API実行」部分に適宜記述を追加してください。

共通モジュール

//------------------------------
// 共通モジュール
//------------------------------
class CommonBase {
    /**
     * シングルトンインスタンス
     * @var UserManager
     */
    protected static $singleton;

    public function __construct() {
        if (self::$singleton) {
            throw new Exception('must be singleton');
        }
        self::$singleton = $this;
    }
    /**
     * シングルトンインスタンスを返す
     * @return UserManager
     */
    public static function getInstance() {
        if (!self::$singleton) {
            return new CommonBase();
        } else {
            return self::$singleton;
        }
    }
    /**
     * V2用 API送信ロジック
     * @return Result
     */
    function apiCurlAction($method, $addUrlPass, $data = null, $multiPart = null, $jsonDecode = null) {
        $header = array(
            "Authorization:Bearer ". API_KEY,
            "X-Spiral-Api-Version: 1.1",
        );
        if($multiPart) {
            $header = array_merge($header, array($multiPart));
        } else {
            $header = array_merge($header, array("Content-Type:application/json"));
        }
        if(APP_ROLE){
			$header = array_merge($header, array("X-Spiral-App-Role: ".APP_ROLE));
		}
        // curl
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_URL, API_URL. $addUrlPass);
        curl_setopt($curl, CURLOPT_HTTPHEADER, $header);
        if ($method == "POST") {
            if ($multiPart) {
                curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
            } else {
                curl_setopt($curl, CURLOPT_POSTFIELDS , json_encode($data));
            }
            curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
        }
        if ($method == "PATCH") {
            curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($data));
            curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
        }
        if ($method == "DELETE") {
            curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($data));
            curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
        }
        $response = curl_exec($curl);
        if (curl_errno($curl)) echo curl_error($curl);
        curl_close($curl);
        if($jsonDecode){
			return $response;
		}else{
            return json_decode($response, true);
		}
    }
}

設定値に関して

共通で使用する値に関しては、定数として初めに設定します。
具体的には下記のような値を設定してください。

API_URL	リクエスト先URLの固定部分です。固定値ですので特に変更する必要はありません。
API_KEY	発行したAPIキーを設定してださい。別途権限の付与が必要になります。
APP_ROLE	設定したアプリロールの識別名を入れてください。全権限の場合は値は空で大丈夫です。
DB_ID	レコード操作を行うDBのIDを設定してください。操作するDBが複数ある場合は「DB_ID_識別名」など適宜定数を追加してください。
APP_ID	レコード操作を行うDBがあるアプリのIDを設定してください。

設定値

define("API_URL", "https://api.spiral-platform.com/v1");
define("API_KEY", "APIキー");
define("APP_ROLE", "アプリロール識別名");
define("DB_ID", "DBID");
define("APP_ID", "アプリID");

補足

define("API_KEY", $SPIRAL->getEnvValue("apikey"));

上記はAPIキーの記述を「PHP環境変数設定」を利用した場合のコードとなります。
このように定数を設定する時に、ver.2 機能の「PHP環境変数設定」を利用することで、
本番環境とテスト環境でキーが異なっていても、コードを書き換える必要がなく、保守性が高まります。
APIキーなど複数ページで使用するものは、環境変数設定をしておきましょう。

その他詳しくはサポートサイト「PHP環境変数」をご参照ください。

EXPRESSメール配信ジョブ一覧取得メソッド

EXPRESSメール配信ジョブ一覧取得を実行したい場合には下記のサンプルコードを使用してみてください。

サンプルコード

<?php
//------------------------------
// 設定値
//------------------------------
define("API_URL", "https://api.spiral-platform.com/v1");
define("API_KEY", "APIキー");
define("APP_ROLE", "アプリロール識別名");
define("DB_ID", "DBID");
define("APP_ID", "アプリID");

//------------------------------
// API実行
//------------------------------
$commonBase = CommonBase::getInstance();

$apiResponse = $commonBase->apiCurlAction("GET", "/apps/". APP_ID.  "/dbs/". DB_ID. "/emailJobs");

//------------------------------
// 共通モジュール
//------------------------------
// ※こちらに「共通モジュール」を必ず記載してください。
?>

APIリファレンス

補足

よく似たメソッドとして、EXPRESSメール設定一覧取得メソッドがありますが、異なる点としては下記となります。

（1）テスト配信ジョブの取得が可能

（2）設定中のジョブは取得はできない

（3）メール件名や文面などの取得はできない

またサンプルコードでは全件取得になっていますが、クエリパラメータに条件を入れることで特定のメール配信ジョブのみ取得可能です。

メール配信ジョブIDを指定して取得

「ids」にメール配信ジョブIDを指定することで、指定したジョブを取得可能です。
カンマで区切ることで複数のIDを指定可能です。

$query = "?ids=1111111,2222222,3333333";

$apiResponse = $commonBase->apiCurlAction("GET", "/apps/". APP_ID.  "/dbs/". DB_ID. "/emailJobs". $query);

EXPRESSメールにはEXPRESSメールIDもありますが、それで指定するとエラーになります。
必ずメール配信ジョブIDを指定するようにしてください。

テスト配信のジョブに絞って取得

「isTest」に true を指定することで、テスト配信のジョブに絞って取得でき、false を指定することで、本番配信のジョブに絞って取得することができます。
未指定の場合はテスト配信と本番配信、両方のジョブを取得可能です。

$query = "?isTest=true"; // テスト配信ジョブのみ取得

$apiResponse = $commonBase->apiCurlAction("GET", "/apps/". APP_ID.  "/dbs/". DB_ID. "/emailJobs". $query);

取得する件数を指定

「limit」の値を指定することで、最大200件のジョブを取得可能です。
未指定の場合はデフォルトで20件のジョブを取得します。

$query = "?limit=200";

$apiResponse = $commonBase->apiCurlAction("GET", "/apps/". APP_ID.  "/dbs/". DB_ID. "/emailJobs". $query);

それぞれの条件を組み合わせて指定もできます、詳細はリファレンスに記載されていますのでご確認ください。

EXPRESSメール配信ジョブ取得メソッド

EXPRESSメール配信ジョブ取得を実行したい場合には下記のサンプルコードを使用してみてください。

サンプルコード

<?php
//------------------------------
// 設定値
//------------------------------
define("API_URL", "https://api.spiral-platform.com/v1");
define("API_KEY", "APIキー");
define("APP_ROLE", "アプリロール識別名");
define("DB_ID", "DBID");
define("APP_ID", "アプリID");

//------------------------------
// API実行
//------------------------------
$commonBase = CommonBase::getInstance();

$emailJobId = "メール配信ジョブID";
$apiResponse = $commonBase->apiCurlAction("GET", "/apps/". APP_ID.  "/dbs/". DB_ID. "/emailJobs/". $emailJobId);

//------------------------------
// 共通モジュール
//------------------------------
// ※こちらに「共通モジュール」を必ず記載してください。
?>

APIリファレンス

補足

上のメソッドと同じくEXPRESSメールIDで指定するとエラーになります。
必ずメール配信ジョブIDを指定するようにしてください。

ver.2 でPHPの実行結果を確認する方法

ver.2 では echo などの関数が使えないため、実行結果を確認するためには Thymeleaf を使用する必要があります。
はじめは分かりにくい部分ではありますので、初歩的な確認方法を以下で解説いたします。

1．ソース設定でフリーコンテンツブロックを作成して以下の Thymeleaf を記載してください。

<div>
    <div th:if="${cp.result.isSuccess}">
        <div th:text="${cp.result.value['API_RESPONSE']}"></div>
    </div>
    <div th:if="${!cp.result.isSuccess}">
        <div th:text="${cp.result.errorMessage}"></div>
    </div>
</div>

2．作成したブロックをページに追加してください。

3．ページの「PHP」タブにコードを記載し、コード内で実行結果を Thymeleaf に渡す記載をしてください。

例：特定のEXPRESSメールジョブを取得してレスポンスを確認したい場合

//------------------------------
// API実行
//------------------------------
$commonBase = CommonBase::getInstance();

$emailJobId = "メール配信ジョブID";
$apiResponse = $commonBase->apiCurlAction("GET", "/apps/". APP_ID.  "/dbs/". DB_ID. "/emailJobs/". $emailJobId);

// レスポンスを Thymeleaf に受け渡す
$SPIRAL->setTHValue("API_RESPONSE", $apiResponse);

上記ページを作成することで、ページURLを開くと実行結果を確認することができます。
ver.2 でPHPのデバッグをしたい場合などに活用してみてください。

開発情報・ナレッジ