スパイラル サポートサイト

powered by SPIRAL PLACE®

HOME > 機能 > ローレベルAPI>custom_module

custom_module


カスタムモジュールに関連するAPIです。


custom_module/upload


カスタムモジュールをアップロードします。
○:必須、△:選択必須


リクエストパラメータ


パラメータ必須説明文字種長
spiral_api_tokenAPIトークン半角英数字
passkeyepoch秒。APIトークンシークレットとpasskeyで署名を作成する。
署名の有効期限チェックにも使用する。有効期限は作成してから30分。
int
signature署名半角英数字
commentモジュールの説明半角英数字, アンスコ, ハイフン 16文字以内
compressZip圧縮されているかどうかboolean
dirアップするパス文字列
srcソースファイル(phpファイル)ファイル(※1)


※1 アップロードするソースファイル(src)に関して、以下の様な制約がありますのでご注意下さい。


  • ファイル名の長さ:128バイト(拡張子を含む)
  • ファイル名に使える文字:半角英数字、ドット、アンダースコア、ハイフン
  • 1ファイル当たりの最大サイズ:256KB
  • 文字エンコード:UTF-8
  • ファイル形式:*.php


通信フォーマット


マルチパート形式を用いてリクエストして下さい。

[HTTP ヘッダ ]

Content-Type: multipart/form-data; boundary="xxxxxxxxxx_MULTIPART_BOUNDARY"
X-SPIRAL-API: custom_module/upload/request //スパイラルAPI ヘッダ



[HTTP ボディ ]

--xxxxxxxxxx_MULTIPART_BOUNDARY
Content-Type: application/json; charset="UTF-8" // 固定文字
Content-Disposition: form-data; name="json" // 固定文字
{
"spiral_api_token":“xxxxxxxxxxxxxxxxxxxxx", ・・・ //jsonデータ
}
--xxxxxxxxxx_MULTIPART_BOUNDARY
Content-Type: application/octet-stream; //固定文字
Content-Disposition: form-data; name="src"; filename="sourceFile.php" //name:src固定、filename:ソースファイル名
[ ファイルのバイナリデータ ]
--xxxxxxxxxx_MULTIPART_BOUNDARY--


レスポンス


パラメータ説明文字種長
code応答コードint
message応答メッセージ半角英数字記号


※.zip(複数のPHPファイル)をアップロードする場合、操作画面のカスタムモジュール一覧からアップロードツールをダウンロードしてお使いください。