LoginSignup
1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

@goofmint(中津川 篤司)inスパイラル株式会社

ローコードプラットフォームSPIRALのAPIを利用する（クリックカウントを作成する）

Last updated at Posted at 2025-07-25

SPIRALは、主にエンタープライズ向けのローコードプラットフォームになります。ローコードプラットフォームなので、プログラミング知識がなくともWebアプリケーションを開発できるのが魅力です。

SPIRALでは、自社のシステムや外部システムと連携する場合を想定して、APIが公開されています。今回は、そのAPIを利用して、メール配信の際に利用できるクリックカウントを作成する流れを解説します。

注意点

SPIRALでは、SPIRAL内部で動作するアカウント内APIと、外部APIの2種類があります。アカウント内APIでは、簡単に操作できるPHP SDKがありますが、外部公開はされていません。そのため、今回はPHPの file_get_contents などを使ってAPI操作をしています。

準備

APIトークンの取得

SPIRALの管理画面で、APIトークンを作成します。ダッシュボードの開発メニュー内のAPIトークンにて、新しいAPIトークンを作成します。

image2.png

作成後に入手できるAPIトークンと、APIトークンシークレットをメモしておきます。

カスタムプログラムの作成

カスタムプログラムは、SPIRALの管理画面から作成します。ダッシュボードの開発メニュー内のカスタムプログラムにて、新しいカスタムプログラムを作成します。

コードについて

今回はPHPで作成しています。ファイル名は click_count.php とします。

APIトークンの保存

APIトークンとシークレット、ログイン用のIDとパスワードは、環境変数に保存します。以下のように .env ファイルを作成し、トークンを保存します。

API_TOKEN=your_api_token
API_TOKEN_SECRET=your_api_token_secret

.env の読み込みは vlucas/phpdotenv を使っています。インストールは composer で行います。

composer require vlucas/phpdotenv

次に、PHPのコード内で .env を読み込みます。

require_once __DIR__ . "/vendor/autoload.php";

$dotenv = Dotenv\Dotenv::createImmutable(__DIR__);
$dotenv->load();

APIリクエストURLの取得

APIでリクエストするURLは、以下の手順で取得します。

// スパイラルの操作画面で発行したトークンを設定します。
$TOKEN = $_ENV['API_TOKEN'];
$SECRET = $_ENV['API_TOKEN_SECRET'];

// -----------------------------------------------------------------------------
// ロケータ
// -----------------------------------------------------------------------------

// ロケータのURL (変更の必要はありません)
$APIURL = "https://www.pi-pe.co.jp/api/locator";

// API用のHTTPヘッダ
$api_headers = array(
    "X-SPIRAL-API: locator/apiserver/request",
    "Content-Type: application/json; charset=UTF-8",
);

// リクエストデータを作成
$parameters = array();
$parameters["spiral_api_token"] = $TOKEN; //トークン

// JSON形式にエンコードします。
$json = json_encode($parameters);

// POSTで送信します。
$stream = stream_context_create(
    array('http' => array(
        'method' => 'POST',
        'protocol_version' => '1.0',
        'header' => $api_headers,
        'content' => $json
    ))
);

// レスポンスデータ読み込み
$response = file_get_contents($APIURL, false, $stream);
$response_json = json_decode($response, true);

// サービス用のURL
$APIURL = $response_json['location'];

この時のレスポンスは以下のようになっています。詳細はSPIRAL ver.1 API リファレンスにて確認してください。

{
  "code": 0,
  "message": "OK",
  "location": "https://（APIサーバ）/api/service",
  "default_version": 2,
  "supported_version": [1, 2],
  "use_client_crt": "f"
}

location にAPIサーバのURLが入っています。

クリックカウントの作成

クリックカウントの作成では、ヘッダーで X-SPIRAL-API: clickcount/create/request を指定します。リクエスト内容はSPIRAL ver.1 API リファレンスを参照してください。

// API用のHTTPヘッダ
$api_headers = array(
    "X-SPIRAL-API: clickcount/create/request",
    "Content-Type: application/json; charset=UTF-8",
);

リクエストパラメータを作成します。 title はカスタムプログラムのタイトルです。

// 送信するJSONデータを作成
$parameters = array();
$parameters["spiral_api_token"] = $TOKEN; //トークン
$parameters["passkey"] = time(); //エポック秒
$parameters["title"] = "clickCountTest"; //クリックカウントのタイトル
$parameters["jump_url"] = "https://www.spiral-platform.co.jp/"; //クリックカウントのジャンプ先URL
$parameters["start_date"] = "2020/04/01 09:00"; // URLが有効になる日時
$parameters["end_date"] = "2037/01/01 00:00"; // URLが無効になる日時
$parameters["url_expiration_enabled"] = "f"; // URLの有効期限を無効にする
$parameters["comment"] = "クリックカウントテスト"; // コメント
$parameters["jump_url_before_start"] = "https://www.spiral-platform.co.jp/#before"; // 開始前のジャンプ先URL
$parameters["jump_url_after_end"] = "https://www.spiral-platform.co.jp/#after"; // 終了後のジャンプ先URL
// クリックカウントのトータルカウントを保存するDBとフィールド
$parameters["total_count"] = array(
    "db_title" => "DemoDB",
    "field_title" => "total_count"
);
// クリックカウントの最終クリック日時を保存するDBとフィールド
$parameters["last_click_date"] = array(
    "db_title" => "DemoDB",
    "field_title" => "last_click_date"
);
// ジャンプ先URLにパラメータを付与
$parameters["url_params"] = array(
    "url_title", // ジャンプ先にURLタイトルを付与する
    "system_id", // レコードIDを付与する
    "rule_id" // 配信ルールIDを付与する
);
// クリックカウントログをTRDBに自動反映するかどうか
$parameters["reflect_log"] = false;

// 署名を付けます
$key = $parameters["spiral_api_token"] ."&" . $parameters["passkey"];
$parameters["signature"] = hash_hmac('sha1', $key, $SECRET, false);

// 送信用のJSONデータを作成します。
$json = json_encode($parameters);

そして、リクエストを実行します。

// 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);
$resdata = json_decode($response, true);

if ($resdata['code'] != "0") {
    echo "Error: " . $resdata['message'] . "\n";
    echo "Code: " . $resdata['code'] . "\n";
    exit(1);
}

echo $resdata['replace_key'];  // %url/https:cnt:clickCountTest%%

実行する

このプログラムを実行します。

% php click_counr.php
%url/https:cnt:clickCountTest%%

この出力された文字列がクリックカウント文字列で、メール配信の際に利用します。そして、URLがメールごとに置き換わり、クリックされた際に、カウントが増加します。

image.png

まとめ

今回はSPIRALのAPIを利用して、クリックカウントを作成する流れを紹介しました。SPIRAL APIでは他にもデータの登録や更新、削除などもAPIを通じて行うことができます。

1分あたりのAPIのリクエスト数は、契約によって上限があります。ご注意ください（詳細はAPIのリクエスト数制限を知りたい SPIRAL ver.1 サポートサイトにて）。

現在、SPIRALではエンジニアβという無料アカウントを配布しています。SPIRALに興味がある型はこちらから試してみてください。

API SPIRAL ver.1 サポートサイト

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?