SPIRALは、主にエンタープライズ向けのローコードプラットフォームになります。ローコードプラットフォームなので、プログラミング知識がなくともWebアプリケーションを開発できるのが魅力です。
SPIRALでは、自社のシステムや外部システムと連携する場合を想定して、APIが公開されています。今回は、そのAPIを利用して、SPIRAL上で実行されるカスタムプログラムをダウンロードする流れを解説します。
注意点
SPIRALでは、SPIRAL内部で動作するアカウント内APIと、外部APIの2種類があります。アカウント内APIでは、簡単に操作できるPHP SDKがありますが、外部公開はされていません。そのため、今回はPHPの file_get_contents などを使ってAPI操作をしています。
準備
APIトークンの取得
SPIRALの管理画面で、APIトークンを作成します。ダッシュボードの開発メニュー内のAPIトークンにて、新しいAPIトークンを作成します。
作成後に入手できるAPIトークンと、APIトークンシークレットをメモしておきます。
カスタムプログラムの作成
カスタムプログラムは、SPIRALの管理画面から作成します。ダッシュボードの開発メニュー内のカスタムプログラムにて、新しいカスタムプログラムを作成します。
コードについて
今回はPHPで作成しています。ファイル名は programming.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: custom_program/get_program_source/request を指定します。リクエスト内容はSPIRAL ver.1 API リファレンスを参照してください。
// API用のHTTPヘッダ
$api_headers = array(
"X-SPIRAL-API: custom_program/get_program_source/request",
"Content-Type: application/json; charset=UTF-8",
);
リクエストパラメータを作成します。 title はカスタムプログラムのタイトルです。
// 送信するJSONデータを作成
$parameters = array();
$parameters["spiral_api_token"] = $TOKEN; //トークン
$parameters["db_title"] = "DemoDB"; //DBのタイトル
$parameters["passkey"] = time(); //エポック秒
$parameters["title"] = "facebookAuth";
// 署名を付けます
$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['source'];
実行する
このプログラムを実行します。
% php programming.php
<?php // <!-- SMP_DYNAMIC_PAGE DISPLAY_ERRORS=OFF NAME=FACEBOOK --> ?>
// 使い方
// https://xxx.smp.ne.jp/regist/is?SMPFORM=xxxx でアクセスすると通常のフォーム
// https://xxx.smp.ne.jp/regist/is?SMPFORM=xxxx&fb=1 でアクセスするとfacebookから情報を参照する
$fbOn = $SPIRAL->getParam("fb"); //フォームのfbの値を取得します
$me = array(); //フォームの初期値を格納する
$fburl = $_SERVER['REQUEST_URI'] . "&fb=1"; //facebook参照用のURLを作成
まとめ
今回はSPIRALのAPIを利用して、カスタムプログラムの内容をダウンロードする流れを紹介しました。SPIRAL APIではファイルダウンロードの他にも、データの登録や更新、削除などもAPIを通じて行うことができます。
1分あたりのAPIのリクエスト数は、契約によって上限があります。ご注意ください（詳細はAPIのリクエスト数制限を知りたい SPIRAL ver.1 サポートサイトにて）。