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?

ローコードプラットフォームSPIRALのAPIを利用する(ファイルをダウンロードする)

Last updated at Posted at 2025-06-27

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トークンシークレットをメモしておきます。

データベースの作成

今回は、作成したのは通常DBになります。SPIRALでは、この他8種類のデータベースが利用できます。

【機能紹介】各種DB | SPIRAL ナレッジサイト

データベースの名前は testdata としました。作成したフィールドは以下の通りです。

フィールド名 サンプル値 差し替えキーワード
名前 テキスト30文字前後 テキストフィールド(64 bytes) name
キー 100 数字・記号・アルファベット(6 bytes) itemKey
ファイル ファイル file

なお、ファイルは最初に特殊フィールドとして作成します。

image.png

作成後、そのフィールドを追加します。

image.png

ファイルをアップロードしておく

今回はダウンロード処理の紹介なので、あらかじめファイル(PDFファイル)をSPIRALの管理画面でアップロードしておきます。

image.png

コードについて

今回はPHPで作成しています。ファイル名は download.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が入っています。

ファイルのダウンロード

ファイルをダウンロードします。 database/get_file/request を指定します。

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

リクエストパラメータの作成

APIにリクエストするパラメータを作成します。以下のようなパラメータを指定します。管理画面上で取得できる、ユニークキーのIDを指定します。

// 送信するJSONデータを作成
$parameters = array();
$parameters["spiral_api_token"] = $TOKEN; //トークン
$parameters["db_title"] = "testdata"; //DBのタイトル
$parameters["passkey"] = time(); //エポック秒
$parameters["file_field_title"] = "file";
$parameters["key_field_title"] = "itemKey";
$parameters["key_field_value"] = "100";

リクエストの実行

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

// 署名を付けます
$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);
}

ファイルの出力

受け取った結果の、 data フィールドにファイルの内容がBase64でエンコードされているので、これをデコードして出力します。また、ファイル名とコンテンツタイプも取得して、適切なヘッダを設定します。

今回はPDFなので、ブラウザで表示できるように、 Content-Disposition ヘッダを inline に設定しています。もしダウンロードさせたい場合は、 attachment に変更してください。

// ファイルの内容をデコード
$data = $resdata['data'];
$file_content = base64_decode(str_replace(' ', '+', $data));
// ファイル名を取得
$file_name = $resdata['file_name'];
// コンテンツタイプを取得
$content_type = $resdata['content_type'];
// 出力
header("Content-Type: $content_type");
header("Content-Disposition: inline; filename=\"$file_name\"");
header("Content-Length: " . strlen($file_content));
echo $file_content;

ファイルが表示できれば、成功です。

image.png

まとめ

今回はSPIRALのAPIを利用して、ファイルをダウンロードする流れを紹介しました。SPIRAL APIではファイルダウンロードの他にも、データの登録や更新、削除などもAPIを通じて行うことができます。

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

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
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?