custom_module

カスタムモジュールに関連するAPIです。機能詳細に関してはリファレンスを参照下さい。

custom_module/upload

カスタムモジュールをアップロードします。

リクエストパラメータ

パラメータ タイプ 説明 文字種長 追加Ver.
spiral_api_token string APIトークン 半角英数字 1.11.4
passkey int epoch秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分。 1.11.4
signature string 署名 半角英数字 1.11.4
comment string モジュールの説明 半角英数字, アンスコ, ハイフン 16文字以内 1.11.4
compress boolean zip圧縮されているかどうか 1.11.4
dir string アップするパス 1.11.4
src file ソースファイル(phpファイルもしくは、それらを圧縮したzipファイル) 下記参照 1.11.4

マルチパート形式を用いてリクエストして下さい。なお、詳細はファイル型などバイナリデータを含む場合を参照して下さい。

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

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

レスポンス

パラメータ タイプ 説明 文字種長 追加Ver.
code int 応答コード 1.11.4
message string 応答メッセージ 半角英数字記号 1.11.4