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

この記事で紹介するサンプルコードでは、共通の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メール配信ログ一覧取得を実行したい場合には下記のサンプルコードを使用してみてください。

サンプルコード

<?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. "/emailLogs");

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

APIリファレンス

補足

EXPRESSメール配信ログの一覧を取得するメソッドです。
ジョブや設定の取得とは違い、一斉配信したメール一件一件の情報をログとして取得することができます。
そしてこのメソッドでは、特定のメールアドレスやレコードIDを指定したり、配信日時を範囲指定して配信ログの取得が可能になっています。

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

メールアドレスを指定して取得

「email」で宛先メールアドレスを指定することで、指定されたメールアドレス宛の配信ログを取得可能です。

$query = "?email=spirers-knowledge@spiral-platform.co.jp";

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

メールアドレスは部分一致で検索されます。また、カンマ区切りで複数指定はできません。

配信日時を指定して取得

下記のパラメータに UTC形式で日付を指定することで、配信日時で絞り込んでメール配信ログを取得することができます。
sinceDeliveryDate：指定した日付以降のメール配信ログで絞り込んで取得
untilDeliveryDate：指定した日付以前のメール配信ログで絞り込んで取得

またこれらのパラメータを組み合わせることで、特定の配信日時を範囲指定して配信ログの取得をすることも可能になっています。

$query = "?sinceDeliveryDate=2023-01-01T00:00:00Z&untilDeliveryDate=2023-01-31T00:00:00Z";

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

指定する日付は上のサンプルのような UTC形式でないとエラーになりますのでご注意ください。

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

「emailJobId」にメール配信ジョブIDを指定することで、特定の配信ログを取得することができます。

$query = "?emailJobId=1111111";

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

カンマ区切りで複数指定はできませんのでご注意ください。

レコードIDを指定して取得

「recordId」にレコードIDを指定することで、特定の配信ログを取得することができます。

$query = "?recordId=1";

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

カンマ区切りで複数指定はできませんのでご注意ください。

エラーコードを指定して取得

「errorCode」にエラーコードを指定することで、特定の配信ログを取得することができます。
指定できる配信エラーコードは、5から始まる恒久的なエラーと4から始まる一時的なエラーです。
エラーコードの詳細に関してはサポートサイト「配信エラーコード」をご参照ください。

また、「NULL」と指定することでエラーがないログを、「NOT NULL」と指定するとエラーがあるログをまとめて取得することが可能です。

$query = "?errorCode=NOT+NULL"; // 半角スペースは「+」もしくは「%20」と記載

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

取得する件数を指定

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

$query = "?limit=200";

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

最後に「enableTotalCount」というパラメータでは、条件にヒットしたログのトータルの件数を返すか返さないかが指定できます。
デフォルトでは false になっているため、レスポンスの「totalCount」が null になってしまいます。
「totalCount」を取得したい場合は忘れずに true を指定してリクエストを行ってください。

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

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実行
//------------------------------
$query = "?recordId=1";

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

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

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

開発情報・ナレッジ

はじめに