SPIRAL ver.1 API リファレンス (1.0)

はじめに

このページはSPIRAL ver.1 APIのリクエストおよびレスポンスの仕様をまとめたAPIリファレンスです。

以下のページも合わせてご覧ください。
・APIリファレンスの読み方(サポートサイトに移動します)
・APIの呼び出し方や共通仕様(サポートサイトに移動します)
・APIのエラーコード一覧(サポートサイトに移動します)
・APIによるマイエリアへのアクセスに関する注意事項(サポートサイトに移動します)

データベース（レコード）

データ登録

データを1行登録します

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/insert/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters データベースのタイトル
required	Array of objects 登録データ。指定しないフィールドは登録しない(NULLになる)。複数行

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "member",
"data": [{"name": "imageName",
"value": "iVBORw0KGgoAAAANSUh ～中略～ RIAAAAASUVORK5CYII=",
"attribute": {"img_name": "test.png",
"img_content_type": "image/png"
}
}
]
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"id": 1
}

データの複数行一括登録

データを複数行（最大1000行）一括登録します
1行でも挿入エラーが発生する行がある場合は、全てロールバックされます

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/bulk_insert/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters データベースのタイトル
columns required	Array of strings 挿入するデータの該当フィールドタイトルの配列。data配列の各行の列数と数が一致している必要がある。画像型、ファイル型のフィールドは指定できません。
data required	Array of Array of strings <= 1000 items 登録するデータ。columnsで指定したフィールド数×登録行数の二次元配列となる。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "member",
"columns": ["email",
"name"
],
"data": [["test001@example.com",
"Tester1"
],
["test002@example.com",
"Tester2"
]
]
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": "0",
"message": "OK",
"ids": [1,
2,
3
]
}

データ更新

検索条件にマッチしたデータを更新します

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/update/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters データベースのタイトル
id	integer <int32> id (id,select_name,search_conditionはANDで検索)
select_name	string <= 128 bytes 抽出ルール名。search_conditionも指定されている時はANDでつなぐ。抽出ルールに抽出結果のレコード数指定がされている場合はレコード数指定が無効になります。
	Array of objects 検索条件（省略時は、検索条件無し）複数行
required	Array of objects 更新データ。指定しないフィールドは更新しない。複数行

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "member",
"id": 178120,
"select_name": "select_name",
"search_condition": [{"name": "registDate",
"value": "2014/01/01",
"operator": "=",
"logical_connection": "and"
}
],
"data": [{"name": "imageName",
"value": "iVBORw0KGgoAAAANSUh ～中略～ RIAAAAASUVORK5CYII=",
"attribute": {"img_name": "test.png",
"img_content_type": "image/png"
}
}
]
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"count": 0
}

データの複数行一括更新

データを複数行（最大1000行）一括更新します

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/bulk_update/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters データベースのタイトル
on_record_not_found	string <半角英数字> Default: "skip" 更新結果が0件の場合の動作を決定する。 "skip"：何もしない（正常終了 code：0）、 "error"：エラー（code：279）。
key required	string <半角英数字, アンスコ, ハイフン> <= 16 更新対象を特定するためのフィールド。一意制約かつ入力必須のフィールドのみ指定可能。
columns required	Array of strings 挿入するデータの該当フィールドタイトルの配列。data配列の各行の列数と数が一致している必要がある。keyで指定したカラムも設定する。パスワード型、画像型、ファイル型は使用不可。
data required	Array of Array of strings <= 1000 items 更新するデータ。columnsで指定したフィールド数×更新行数の二次元配列となる。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "member",
"on_record_not_found": "skip",
"key": "email",
"columns": ["email",
"name"
],
"data": [["test001@example.com",
"Tester1"
],
["test002@example.com",
"Tester2"
]
]
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"tip": "key = email",
"results": [{"status": "updated",
"id": 1
}
]
}

データ更新または登録

検索条件にマッチしたデータを更新します。検索条件にマッチしなかった場合、データを1行登録します。
ファイル型の場合マルチパートデータとして送る必要があります。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/upsert/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters データベースのタイトル
key required	string <半角英数字, アンスコ, ハイフン> <= 16 更新対象を特定するためのフィールド。一意制約かつ入力必須のフィールドのみ指定可能。
required	Array of objects 登録、更新データ。指定しないフィールドは登録しない、または更新しない。複数行

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "member",
"key": "email",
"data": [{"name": "imageName",
"value": "iVBORw0KGgoAAAANSUh ～中略～ RIAAAAASUVORK5CYII=",
"attribute": {"img_name": "test.png",
"img_content_type": "image/png"
}
}
]
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"result": {"status": "inserted",
"id": 1
}
}

データ一括更新または登録

検索条件にマッチしたデータを一括更新します。検索条件にマッチしなかった場合はデータを登録します（最大1000行）。
データのレコード数分、更新、登録処理を繰り返し、処理結果を配列で返却します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/bulk_upsert/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters データベースのタイトル
key required	string <半角英数字, アンスコ, ハイフン> <= 16 更新対象を特定するためのフィールド。一意制約かつ入力必須のフィールドのみ指定可能。
columns	Array of strings 更新データの該当フィールドタイトルの配列。 data配列の各行の列数と数が一致している必要がある。keyで指定したカラムも設定する。 keyで指定したフィールドは更新時には更新対象を特定する条件に用い、挿入時には登録データに使用する。パスワード型、画像型、ファイル型は使用不可。
data required	Array of Array of strings <= 1000 items 更新または登録するデータ。 columnsで指定したフィールド数×登録行数の二次元配列となる。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "member",
"key": "email",
"columns": ["email",
"name"
],
"data": [["test001@example.com",
"Tester1"
],
["test002@example.com",
"Tester2"
]
]
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"tip": "string",
"results": [{"status": "inserted",
"id": 1
}
]
}

データ削除

検索条件にマッチしたデータを削除します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/delete/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters データベースのタイトル
id	integer <int32> id (id,select_name,search_conditionはANDで検索)
select_name	string <= 128 bytes 抽出ルール名。search_conditionも指定されている時はANDでつなぐ。抽出ルールに抽出結果のレコード数指定がされている場合はレコード数指定が無効になります。
	Array of objects 検索条件（省略時は、検索条件無し）複数行

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "member",
"id": 100,
"select_name": "rule_name",
"search_condition": [{"name": "name",
"value": "花子",
"operator": "=",
"logical_connection": "and"
}
]
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"count": 10
}

データ取得

DB内のデータを取得します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/select/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters データベースのタイトル
lines_per_page	integer <int32> [ 1 .. 1000 ] Default: 10 ページ毎のデータ行数。
page	integer <int32> >= 1 Default: 1 ページ番号。
select_columns	Array of strings 取得したいフィールドタイトルの配列。idも指定可能。 group_byを指定した場合、select_columnsに指定できるフィールドタイトルはgroup_byで指定したカラムに限定される。
	object データ本体の出力形式。画像型フィールドのみ対応。画像型フィールド以外の場合、本パラメータの指定は無視される。各フィールドタイトルに対する表示形式をマップ形式で指定する。同じ画像型フィールドを複数の出力形式で取得する場合は、select_columnsとdata_formatに以下のように指定する。 select_columnsには、data_formatで指定した出力形式の数だけ、フィールドの指定を行う。例：imageフィールドを複数の出力形式で取得（1列目はthumbnail_image_url形式、2列目はoriginal_image_url形式） `{ "select_columns": [ "image", "image" ], "data_format": { "image": [ "thumbnail_image_url", "original_image_url" ] } }`
select_name	string <= 128 bytes 抽出ルール名。search_conditionも指定されている時はANDでつなぐ。抽出ルールに抽出結果のレコード数指定がされている場合はレコード数指定が無効になります。
labels_target	string Default: "no_id" Enum: "all" "no_id" レスポンスボディ「label」に、出力するフィールドの指定。「all」の場合、select_columnsで指定したフィールド全てのラベルを出力する。「no_id」の場合、select_columnsで指定したうち「id以外」のラベルを出力する。 select_columnsにidを含まない場合、labels_targetによる差異は生じない。
	Array of objects 検索条件（省略時は、検索条件無し）複数行
	Array of objects ソート条件（省略時は、ソート条件無し）複数行
group_by	Array of strings グルーピングしたいフィールドタイトルの配列。select_columnsに指定できるフィールドタイトルは、ここで指定したフィールドタイトルに限定される。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "member",
"lines_per_page": 10,
"page": 1,
"select_columns": ["email",
"name",
"food",
"image"
],
"data_format": {"image": "normal"
},
"select_name": "rule_name",
"labels_target": "all",
"search_condition": [{"name": "email",
"value": "@example.com",
"operator": "=",
"logical_connection": "and"
}
],
"sort": [{"name": "name",
"order": "asc"
}
],
"group_by": ["email",
"name",
"food",
"image"
]
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"header": ["メールアドレス",
"名前",
"食べ物",
"サムネイル画像"
],
"data": [["test1@example.com",
"テスト1",
"1",
"/9j/4AAQSkZJRg～中略～UpSlKUpSlKUr/2Q=="
],
["test2@example.com",
"テスト2",
"2",
"/9j/4AAQSkZJRg～中略～MgkOkVWiv/9k="
]
],
"label": [{"1": "りんご",
"2": "みかん"
}
],
"count": 0
}

ファイルデータ取得

ファイル型フィールドに格納されているファイルデータを取得します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/get_file/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters データベースのタイトル
file_field_title required	string <半角英数字, アンスコ, ハイフン> <= 16 取得したいファイルのフィールド
key_field_title required	string <半角英数字, アンスコ, ハイフン> <= 16 取得対象を特定するためのフィールド。一意制約のフィールドのみ指定可能（IDも可）。
key_field_value required	string <フィールドタイプに依存> 取得対象を特定するための値（null、空値の入力は許容しない）。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "member",
"file_field_title": "file",
"key_field_title": "email",
"key_field_value": "test@example.com"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"file_name": "test.pdf",
"data": "JVBERi0xLjcKCjQg～中略～ZgoxMzk4NQolJUVPRgo=",
"content_type": "application/pdf"
}

データベース（スキーマ）

指定フィールドの共有フィールド確認

指定したフィールドが共有フィールドであるかどうかを確認します。
指定したフィールドが共有フィールドである場合、フィールドの詳細情報を取得します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/get_share_field/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
field_title required	string <半角英数字, アンスコ, ハイフン> 確認対象フィールドのタイトル

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"field_title": "name"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"data": [{"id": 1,
"name": "email",
"code": "f002174026",
"title": "メールアドレス（大・小文字無視）",
"type": "mm_email_nc"
}
]
}

共有フィールド一覧の取得

既に設定されている共有フィールドの一覧を取得します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/get_share_fields/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"data": [{"id": 2176991,
"name": "select",
"code": "f002176991",
"title": "selectTest",
"type": "mm_alternative"
}
]
}

DB一覧の取得

指定したDBタイプの一覧を取得します。DBタイプを指定しない場合、全てのDBタイプの一覧を取得します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/get_db_list/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_type	Array of strings 取得対象DBタイプは、配列で複数指定可能。空の配列または配列を指定しない場合、全DBタイプの一覧を取得する。パラメータに指定する値は下記の通りです。 db_typeの値：操作画面上のDBタイプ名・normal：通常DB ・history：履歴DB ・transaction：トランザクションDB ・view_1：仮想DB(フィルタ型) ・view_n：仮想DB(連携型) ・union：仮想DB(集合型) ・attachment：画像マスタDB ・forum.topic：トピックDB ・forum.comment：コメントDB ・stop：STOPDB

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_type": ["normal"
]
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"data": [{"id": 178120,
"name": "テストDB",
"title": "dbTest",
"code": "d000178120",
"type": "normal"
}
]
}

DBの新規作成

データベース設定情報からDBを新規作成します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/create/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
type	string <半角英数字> Default: "normal" データベースタイプ。'normal', 'history'のみ。
required	object スキーマ

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"type": "normal",
"schema": {"name": "テストDB",
"title": "testDB",
"comment": "テスト用のデータベース",
"record_limit": 100,
"fieldList": [{"type": "mm_email_nc",
"title": "f002174026",
"shared": "f",
"name": "email",
"primary_key_flg": "t",
"unique_flg": "t",
"not_null_flg": "t",
"comment": "メールアドレス",
"set_default": "フィールドタイプに依存",
"default_string": "@example.com",
"autoval_trig": "testTrigger",
"index_flg": "f",
"label": {"keywordAry": ["label1",
"label2",
"label3"
],
"idAry": ["1",
"2",
"3"
]
}
}
]
}
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK"
}

DB情報の取得

DBの情報を取得します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/get/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters データベースのタイトル
get_allocatable_record_limit	string <boolean (t or f)> Default: "f" 割り当て可能レコード数を取得するかどうかのフラグ値。割り当て可能レコード数の取得は重くなるため、必要ないときはfを推奨。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "member",
"get_allocatable_record_limit": "f"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"type": "normal",
"schema": {"name": "テストデータベース",
"title": "dbTestDatabase",
"record_limit": 10,
"allocatable_record_limit": 0,
"comment": "コメント",
"fieldList": [{"type": "mm_email_nc",
"title": "email",
"shared": "f",
"name": "メールアドレス（大・小文字無視）",
"primary_key_flg": "t",
"unique_flg": "t",
"not_null_flg": "t",
"comment": "メールアドレスのコメント",
"set_default": "default@example.com",
"default_string": "example.com",
"autoval_trig": "trig1",
"index_flg": "t",
"label": {"keywordAry": ["label1",
"label2",
"label3"
],
"idAry": ["1",
"2",
"3"
]
}
}
]
}
}

通常DBの設定変更

通常DBの設定を変更します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/alter/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters データベースのタイトル
record_limit	integer <int32> 割り当てレコード数

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "member",
"record_limit": 10
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"rest_record": 0
}

通常DBの削除

通常DBを削除します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: database/drop/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters データベースのタイトル
force_drop	string <boolean (t or f)> Default: "f" 強制削除を許可するかのフラグ。許可する=t、許可しない=f。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "member",
"force_drop": "f"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK"
}

DBフィルター

抽出ルール作成

抽出ルール（DBおよびフィールド）を作成します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: db_filter/create/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters データベースのタイトル
select_name required	string <= 128 bytes 抽出ルール名（日本語利用可能）
	object ID範囲指定
	object モジュロ演算
limit	integer <int32> 抽出結果のレコード数指定
regist_authorizer	Array of strings <= 80 items 登録元指定。配列
	object 連携DB関連
	Array of objects フィールド抽出ルール。条件はAND結合。複数行

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "member",
"select_name": "テストフィルター",
"id_range": {"ge": 1,
"lt": 10
},
"modulo": {"divisor": 2,
"surplus": 1
},
"limit": 10,
"regist_authorizer": ["427999",
"428649"
],
"exists": {"db_title": "member",
"db_filter_id": 195435,
"include": "t"
},
"fields": [{"name": "email",
"label": "filterTest",
"value1": "1",
"value2": "10",
"condition": "between",
"exclude": "f"
}
]
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"id": 195435
}

抽出ルールのリストを出力

抽出ルールのリストを出力します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: db_filter/list/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters データベースのタイトル
select_name	string <= 128 bytes 抽出ルール名の部分一致検索。省略時は全件検索

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "member",
"select_name": "testFilter"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"data": [{"id": 195435,
"select_name": "testFilter"
}
]
}

抽出ルールの内容を取得

抽出ルールの内容を取り出します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: db_filter/get/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title	string <半角英数字, アンスコ, ハイフン> <= 16 抽出ルールを持つデータベースのタイトル。※db_tileとname、またはidのどちらかを指定する。
select_name	string <= 128 bytes 抽出ルール名（完全一致）
id	string <選択内容に依存> 抽出ルールID。※db_tileとname、またはidのどちらかを指定する。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "dbMember",
"select_name": "testFilter",
"id": "195435"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"id": 195435,
"db_title": "member",
"select_name": "testFilter",
"id_range": {"ge": 1,
"lt": 10
},
"modulo": {"divisor": 2,
"surplus": 1
},
"limit": 10,
"regist_authorizer": ["427999",
"428649"
],
"exists": {"db_title": "member",
"db_filter_id": 195435,
"include": "t"
},
"fields": [{"name": "email",
"label": "domain",
"value1": 1,
"value2": 10,
"condition": "domain_is",
"exclude": "f"
}
]
}

抽出ルールの削除

抽出ルールを削除します。
指定されたDBに抽出ルールが2つ以上存在する場合は、フィールド抽出ルールを削除しません。
1つしか無い場合は、そのDBの新規フィールドに対してのフィールド抽出ルールは削除します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: db_filter/delete/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title	string <半角英数字, アンスコ, ハイフン> <= 16 抽出ルールを持つデータベースのタイトル。db_tileとselect_nameの組み合わせ、またはidのどちらかを指定する。
select_name	string <= 128 bytes 抽出ルール名（完全一致）。db_tileとselect_nameの組み合わせ、またはidのどちらかを指定する。
id	integer <int32> 抽出ルールID。db_tileとselect_nameの組み合わせ、またはidのどちらかを指定する。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "dbMember",
"select_name": "testFilter",
"id": 195435
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK"
}

PDF帳票

PDF帳票の一覧取得

PDF帳票の一覧を取得するAPIです。
PDF帳票の設定についてはこちらをご覧ください。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: pdf_report/list/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
page	integer <int32> >= 1 Default: 1 取得するページ番号 1ページあたり10件までPDF帳票情報が表示される。 PDF帳票を作成した順に表示される。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"page": 2
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"total_count": 2,
"pdf_reports": [{"name": "PDF帳票_01",
"keyword": "pdf_report_01",
"db_title": "database",
"template_file_name": "pdf_report_template_01.pdf",
"comment": "PDF帳票_01です。"
},
{"name": "PDF帳票_02",
"keyword": "pdf_report_02",
"db_title": "database",
"template_file_name": "pdf_report_template_02.pdf",
"comment": "PDF帳票_02です。"
}
]
}

PDF帳票の取得

PDF帳票取得するAPIです。
PDF帳票の設定についてはこちらをご覧ください。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: pdf_report/get/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
keyword required	string <半角英数記号> 取得対象のPDF帳票キーワード

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"keyword": "pdf_report"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"name": "PDF帳票",
"keyword": "pdf_report",
"db_title": "database",
"comment": "PDF帳票です。",
"template_file_name": "pdf_report_template.pdf",
"download_count_field": "download_count",
"last_download_reporting_field": "last_download",
"output_fields": [{"name": "name1",
"source": "db",
"db_field": "mail",
"format": {"type": "value"
}
},
{"name": "name2",
"source": "db",
"db_field": "optionSelect",
"format": {"type": "label"
}
},
{"name": "name3",
"source": "db",
"db_field": "mail",
"format": {"type": "qr",
"qr_error_correction_level": 7
}
},
{"name": "name4",
"source": "db",
"db_field": "picture1",
"format": {"type": "image",
"image_scaling": "aspect_fit"
}
},
{"name": "name5",
"source": "output_date",
"format": {"type": "output_date",
"date_pattern": "ymd_jp"
}
}
],
"pdf_security": {"user_password_field": "passField1",
"owner_password_field": "passField2",
"encryption_algorithm": "aes_128",
"permissions": {"copying": "granted",
"printing": "granted",
"assembly": "granted"
}
},
"access": {"authority": "my_area",
"allowed_my_areas": ["my_area_01",
"my_area_02"
]
},
"ip_restriction": {"allowed_ips": ["192.168.0.101",
"192.168.0.0/24",
"192.168.0.1 - 192.168.0.255"
]
},
"referrer_restriction": {"allowed_referrers": ["example.com",
"example2.com"
]
},
"download_period": {"type": "field",
"start_field": "dl_start_field",
"end_field": "dl_end_field"
}
}

PDF帳票テンプレートファイルの取得

PDF帳票テンプレートファイルを取得するAPIです。
PDF帳票の設定についてはこちらをご覧ください。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: pdf_report/get_template/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
keyword required	string <半角英数記号> 取得対象のPDF帳票キーワード

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"keyword": "pdf_report"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"file_name": "PDF_TEMPLATE.pdf",
"data": "JVBERi0xLjMKJcTl8uXrp/Og0MTGCjMgMCBvYmoK..."
}

PDF帳票ファイルの取得

PDF帳票のファイルを取得するAPIです。
PDF帳票の機能概要についてはこちらをご覧ください。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: pdf_report/get_file/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
pdf_report_title required	string <半角英数字, アンスコ, ハイフン> <= 16 PDF帳票のキーワード
key_field_title required	string <半角英数字, アンスコ, ハイフン> <= 16 取得対象を特定するためのフィールド一意制約のフィールドのみ指定可能（IDも可）。
key_field_value required	string <フィールドタイプに依存> 取得対象を特定するための値（null、空値の入力は許容しない）

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"pdf_report_title": "PdfReport",
"key_field_title": "email",
"key_field_value": "test@example.com"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"file_name": "PDF_TEMPLATE.pdf",
"data": "JVBERi0xLjcKCjQg～中略～ZgoxMzk4NQolJUVPRgo="
}

PDF帳票の作成

PDFを作成するAPIです。
PDF帳票の設定についてはこちらをご覧ください。

このAPIはマルチパートリクエストが必要です。

リクエストのContent-Typeには multipart/form-data; boundary=***※を指定し、boundary で指定した値（＝以降の値）で区切りながら次の2つのパートを含めてください。 ※ *** の箇所は任意

パート	説明	ヘッダの記述例
JSON	作成するPDF帳票の情報。詳細は「REQUEST BODY SCHEMA」を参照	Content-Type: application/json; charset=UTF-8 Content-Disposition: form-data; name='json'
PDFテンプレート	作成するPDF帳票のPDFテンプレートファイル	Content-Type: application/pdf; Content-Disposition: form-data; name='template'; filename='PDFファイル名'

PHPでのSPIRAL(ver.1)APIのマルチパートリクエストはこちらをご覧ください

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: multipart/form-data; boundary=***
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: pdf_report/create/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
name required	string [ 1 .. 128 ] bytes PDF帳票名
keyword required	string <半角英数字, アンスコ, ハイフン> [ 4 .. 16 ] characters PDF帳票キーワード
db_title required	string <半角英数記号> データベースのタイトル
comment	string PDF帳票コメント
download_count_field	string <半角英数字, アンスコ, ハイフン> ダウンロードカウントフィールドダウンロードカウント数を記録するDBフィールドのタイトルを指定する。ダウンロードカウント数を記録しない場合はnullを指定するまたはパラメータ未指定とする。
last_download_reporting_field	string <半角英数字, アンスコ, ハイフン> 最終ダウンロード日時フィールド最終ダウンロード日時を記録するDBフィールドのタイトルを指定する。最終ダウンロード日時を記録しない場合はnullを指定するまたはパラメータ未指定とする。
	Array of objects <= 150 items PDF出力フィールド設定
	object PDFセキュリティ設定 PDFセキュリティ設定を無効化する場合はnullを指定するまたはパラメータ未指定とする。ユーザーパスワード設定フィールド、オーナーパスワード設定フィールドいずれか一方はフィールドタイトルを指定する必要がある。
	object アクセス制限パラメータ未指定の場合は、`authority: user` が指定されたものとする。
	object IPアドレス制限設定 IPアドレス制限設定を無効化する場合、nullを指定するまたはパラメータ未指定とする。
	object 接続元URL制限設定接続元URL制限設定を無効化する場合、nullを指定するまたはパラメータ未指定とする。
	object ダウンロード可能期間設定パラメータ未指定の場合は、`type: free` が指定されたものとする。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"name": "PDF帳票",
"keyword": "pdf_report",
"db_title": "database",
"comment": "PDF帳票です。",
"download_count_field": "download_count",
"last_download_reporting_field": "last_download",
"output_fields": [{"name": "mail_address",
"source": "db",
"db_field": "mail_field",
"format": {"type": "value"
}
},
{"name": "gender",
"source": "db",
"db_field": "gender",
"format": {"type": "label"
}
},
{"name": "mail_address_qr",
"source": "db",
"db_field": "mail_address",
"format": {"type": "qr",
"qr_error_correction_level": 7
}
},
{"name": "picture",
"source": "db",
"db_field": "picture",
"format": {"type": "image",
"image_scaling": "aspect_fit"
}
},
{"name": "contract_date",
"source": "output_date",
"format": {"type": "output_date",
"date_pattern": "ymd_jp"
}
}
],
"pdf_security": {"encryption_algorithm": "rc4_128",
"user_password_field": "user_password",
"owner_password_field": "owner_password",
"permissions": {"copying": "granted",
"printing": "low_resolution_granted",
"assembly": "granted"
}
},
"access": {"authority": "my_area",
"allowed_my_areas": ["my_area_01",
"my_area_02"
]
},
"ip_restriction": {"allowed_ips": ["192.168.0.1",
"192.168.1.0/24",
"192.168.2.128-192.168.0.255"
]
},
"referrer_restriction": {"allowed_referrers": ["example.com",
"https://example.com"
]
},
"download_period": {"type": "field",
"start_field": "dl_start_field",
"end_field": "dl_end_field"
}
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK"
}

PDF帳票の更新

PDF帳票を更新するAPIです。
PDF帳票の設定についてはこちらをご覧ください。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: pdf_report/update/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
keyword required	string <半角英数記号> 更新対象のPDF帳票キーワード
name	string [ 1 .. 128 ] bytes PDF帳票名
update_keyword	string <半角英数字, アンスコ, ハイフン> [ 4 .. 16 ] characters 更新後のPDF帳票キーワード
comment	string PDF帳票コメント
download_count_field	string <半角英数字, アンスコ, ハイフン> ダウンロードカウントフィールドダウンロードカウント数を記録するDBフィールドのタイトルを指定する。ダウンロードカウント数を記録しない場合はnullを指定する。パラメータ未指定の場合は更新されない。
last_download_reporting_field	string <半角英数字, アンスコ, ハイフン> 最終ダウンロード日時フィールド最終ダウンロード日時を記録するDBフィールドのタイトルを指定する。最終ダウンロード日時を記録しない場合はnullを指定する。パラメータ未指定の場合は更新されない。
	Array of objects <= 150 items PDF出力フィールド設定パラメータ未指定の場合は更新されない。
	object PDFセキュリティ設定 PDFセキュリティ設定を無効化する場合はnullを指定する。パラメータ未指定の場合は更新されない。ユーザーパスワード設定フィールド、オーナーパスワード設定フィールドいずれか一方はフィールドタイトルを指定する必要がある。
	object アクセス制限パラメータ未指定の場合は更新されない。
	object IPアドレス制限設定 IPアドレス制限設定を無効化する場合nullを指定する。パラメータ未指定の場合は更新されない。
	object 接続元URL制限設定接続元URL制限設定を無効化する場合nullを指定する。パラメータ未指定の場合は更新されない。
	object ダウンロード可能期間設定パラメータ未指定の場合は更新されない。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"keyword": "pdf_report",
"name": "PDF帳票",
"update_keyword": "new_pdf_report",
"comment": "PDF帳票です。",
"download_count_field": "download_count",
"last_download_reporting_field": "last_download",
"output_fields": [{"name": "mail_address",
"source": "db",
"db_field": "mail_field",
"format": {"type": "value"
}
},
{"name": "gender",
"source": "db",
"db_field": "gender",
"format": {"type": "label"
}
},
{"name": "mail_address_qr",
"source": "db",
"db_field": "mail_address",
"format": {"type": "qr",
"qr_error_correction_level": 7
}
},
{"name": "picture",
"source": "db",
"db_field": "picture",
"format": {"type": "image",
"image_scaling": "aspect_fit"
}
},
{"name": "contract_date",
"source": "output_date",
"format": {"type": "output_date",
"date_pattern": "ymd_jp"
}
}
],
"pdf_security": {"encryption_algorithm": "rc4_128",
"user_password_field": "user_password",
"owner_password_field": "owner_password",
"permissions": {"copying": "granted",
"printing": "low_resolution_granted",
"assembly": "granted"
}
},
"access": {"authority": "my_area",
"allowed_my_areas": ["my_area_01",
"my_area_02"
]
},
"ip_restriction": {"allowed_ips": ["192.168.0.1",
"192.168.1.0/24",
"192.168.2.128-192.168.0.255"
]
},
"referrer_restriction": {"allowed_referrers": ["example.com",
"https://example.com"
]
},
"download_period": {"type": "field",
"start_field": "dl_start_field",
"end_field": "dl_end_field"
}
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK"
}

PDF帳票テンプレートファイルの更新

PDF帳票テンプレートファイルを更新するAPIです。
PDF帳票の設定についてはこちらをご覧ください。

このAPIはマルチパートリクエストが必要です。

パート	説明	ヘッダの記述例
JSON	PDFテンプレートを更新するPDF帳票の情報。詳細は「REQUEST BODY SCHEMA」を参照	Content-Type: application/json; charset=UTF-8 Content-Disposition: form-data; name='json'
PDFテンプレート	作成するPDF帳票のPDFテンプレートファイル	Content-Type: application/pdf; Content-Disposition: form-data; name='template'; filename='PDFファイル名'

PHPでのSPIRAL(ver.1)APIのマルチパートリクエストはこちらをご覧ください

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: multipart/form-data; boundary=***
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: pdf_report/update_template/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
keyword required	string <半角英数記号> 更新対象のPDF帳票キーワード

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"keyword": "pdf_report"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK"
}

PDF帳票の削除

PDF帳票を削除するAPIです。
PDF帳票の設定についてはこちらをご覧ください。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: pdf_report/delete/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
keyword required	string <半角英数記号> 削除対象のPDF帳票キーワード

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"keyword": "pdf_report"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK"
}

マイエリア

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
my_area_title required	string <半角英数字, アンスコ, ハイフン> <= 16 マイエリアのタイトル
id	string <マイエリア設定に基づく> 会員識別キー
key	string <マイエリア設定に基づく> 自動発行キー
password	string <マイエリア設定に基づく> パスワード
url_type	integer <int32> [ 0 .. 2 ] Default: 0 URLのパスを「/area/」or「/area/afp/」か選択できる。 0:/area/ 1:/area/afp/ 2:レスポンスのurlにjsessionidが付かない（urlのパスは0の時と同じ）。
auto_login	string <boolean (t or f)> Default: "f" 自動ログインフラグ f：自動ログインしない t：自動ログインする。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"my_area_title": "api_auth",
"id": "test01",
"key": "MfgE3XXX",
"password": "pass01",
"url_type": 2,
"auto_login": "f"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"jsessionid": "0323029CFD30EFA31C00912FC11F6D6B",
"session_expire": 1603250145,
"url": "https://www.example.com/area/servlet/area.MyPageBundle?MyPageID=f541～中略～eh7l1",
"auto_login_cookie": "r109112=3822feb～中略～92b3433dded",
"auto_login_limit": 1603334087
}

ログアウト

マイエリアからログアウトする

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: area/logout/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
jsessionid required	string <半角英数大文字> マイエリアにログインした際のセッションID
auto_login_cookie	string <半角英数記号> マイエリアにログインした際のauto_login_cookieの値（※選択必須）
my_area_title required	string <半角英数字, アンスコ, ハイフン> <= 16 マイエリアのタイトル

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"jsessionid": "E7D021DF2E9657C51EBA8B4B340B98FC",
"auto_login_cookie": "r109112=3822feb0b9b821～中略～b73be7a47",
"my_area_title": "api_auth"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"url": "https://www.example.com/area/servlet/area.MyPageBundle?MyPageID=f541～中略～eh7l1",
"jsessionid": "0323029CFD30EFA31C00912FC11F6D6B",
"auto_login_cookie": "r109112=3822feb～中略～92b3433dded",
"auto_login_limit": 1603334087
}

ステータス

マイエリアのログイン状態を確認し、ログインセッションが有効な場合はセッション有効期間を延長します

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: area/status/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
jsessionid required	string <半角英数大文字> マイエリアにログインした際のセッションID
auto_login_cookie	string <半角英数記号> マイエリアにログインした際のauto_login_cookieの値（※選択必須）
my_area_title required	string <半角英数字, アンスコ, ハイフン> <= 16 マイエリアのタイトル

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"jsessionid": "E7D021DF2E9657C51EBA8B4B340B98FC",
"auto_login_cookie": "r109112=3822feb0b9b821～中略～b73be7a47",
"my_area_title": "api_auth"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"jsessionid": "0323029CFD30EFA31C00912FC11F6D6B",
"session_expire": 1603250145,
"auto_login_cookie": "r109112=3822feb～中略～92b3433dded",
"auto_login_limit": 1603334087,
"status": 1
}

カスタムマイページ

マイエリアのカスタムマイページのURLを取得します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: area/mypage/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
jsessionid	string <半角英数大文字> マイエリアにログインした際のセッションID（※選択必須）
auto_login_cookie	string <半角英数記号> マイエリアにログインした際のauto_login_cookieの値（※選択必須）
my_area_title required	string <半角英数字, アンスコ, ハイフン> <= 16 マイエリアのタイトル
my_page_id required	integer <int32> マイページ番号
url_type	integer <int32> [ 0 .. 1 ] Default: 0 URLのパスを「/area/」or「/area/afp/」か選択できる 0:/area/ 1:/area/afp/

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"jsessionid": "E7D021DF2E9657C51EBA8B4B340B98FC",
"auto_login_cookie": "r109112=3822feb0b9b821～中略～b73be7a47",
"my_area_title": "api_auth",
"my_page_id": 259665,
"url_type": 2
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"url": "https://www.example.com/area/servlet/area.MyPageBundle?MyPageID=fda5aeb5_mjrg6mftdqf5o4",
"jsessionid": "0323029CFD30EFA31C00912FC11F6D6B",
"auto_login_cookie": "r109112=3822feb～中略～92b3433dded",
"auto_login_limit": 1603334087
}

一覧表

一覧表データ取得

一覧表のデータを取得します

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: table/data/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
jsessionid	string <半角英数大文字> マイエリアにログインした際のセッションID（※選択必須）
auto_login_cookie	string <半角英数記号> マイエリアにログインした際のauto_login_cookieの値（※選択必須）
my_area_title required	string <半角英数字, アンスコ, ハイフン> <= 16 マイエリアのタイトル
search_title required	string <半角英数字, アンスコ, ハイフン> 一覧表検索フォームタイトル
lines_per_page	integer <int32> [ 1 .. 1000 ] Default: 10 ページ毎のデータ行数。
page	integer <int32> >= 1 Default: 1 ページ番号。
	Array of objects ソート条件（省略時は、一覧表のソート条件に準ずる）複数行
	Array of objects 検索条件（省略時は、検索条件無し）複数行
mst_filter_title	string <半角英数字, アンスコ, ハイフン> <= 16 マスタとしてフィルターしたい一覧表検索フォームタイトル
mst_filter_value	integer <int32> マスタフィルターで使用するマスタDBのid
terminal_ip_address	string <IPアドレス仕様> エンドユーザ(末端)のIPアドレス。指定したIPアドレスのみアクセスを許可する。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"jsessionid": "E7D021DF2E9657C51EBA8B4B340B98FC",
"auto_login_cookie": "r109112=3822feb0b9b821～中略～b73be7a47",
"my_area_title": "api_auth",
"search_title": "search_title",
"lines_per_page": 10,
"page": 1,
"sort": [{"name": "name",
"order": "asc"
}
],
"search_condition": [{"name": "body",
"value": "本文0",
"exists": 0,
"ex_type": "and",
"action": 0
}
],
"mst_filter_title": "filterTitle",
"mst_filter_value": 178120,
"terminal_ip_address": "vvv.xxx.yyy.zzz"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"count": 15,
"header": ["[name, email]"
],
"data": [["email",
"test.tarou@example.com"
]
],
"jsessionid": "0323029CFD30EFA31C00912FC11F6D6B",
"auto_login_cookie": "r109112=3822feb～中略～92b3433dded",
"auto_login_limit": 1603334087
}

単票URL取得

指定したレコードの単票URLを取得します

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: table/card/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
jsessionid	string <半角英数大文字> マイエリアにログインした際のセッションID（※選択必須）
auto_login_cookie	string <半角英数記号> マイエリアにログインした際のauto_login_cookieの値（※選択必須）
my_area_title required	string <半角英数字, アンスコ, ハイフン> <= 16 マイエリアのタイトル
card_title required	string <半角英数字, アンスコ, ハイフン> 単票のタイトル
ids required	Array of integers <= 1000 items 表示するレコードのレコードID。
terminal_ip_address	string <IPアドレス仕様> エンドユーザ(末端)のIPアドレス。指定したIPアドレスのみアクセスを許可する。
url_type	integer <int32> [ 0 .. 2 ] Default: 0 urlsで返されるurlにjsessionidを含むかどうか選択できる。 0:通常のurl 2:レスポンスのurlにjsessionidが付かない。指定がない場合や、上記以外の値が指定された場合は、default値が使用される。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"jsessionid": "E7D021DF2E9657C51EBA8B4B340B98FC",
"auto_login_cookie": "r109112=3822feb0b9b821～中略～b73be7a47",
"my_area_title": "api_auth",
"card_title": "api_card",
"ids": [100,
101,
102
],
"terminal_ip_address": "vvv.xxx.yyy.zzz",
"url_type": 2
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"urls": ["https://FQDN/area/card/・・・/・・・/M?S=・・・",
"https://FQDN/area/card/・・・/・・・/M?S=・・・"
],
"jsessionid": "0323029CFD30EFA31C00912FC11F6D6B",
"auto_login_cookie": "r109112=3822feb～中略～92b3433dded",
"auto_login_limit": 1603334087
}

集計表

集計表データ取得

集計表データを取得します

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: sumtable/data/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
jsessionid	string <半角英数大文字> マイエリアにログインした際のセッションID（※選択必須）
auto_login_cookie	string <半角英数記号> マイエリアにログインした際のauto_login_cookieの値（※選択必須）
totalizer_title required	string <半角英数字, アンスコ, ハイフン> <= 16 集計表タイトル（集計表設定から取得可能）
my_area_title required	string <半角英数字, アンスコ, ハイフン> <= 16 マイエリアのタイトル
history	integer <int32> >= 0 集計履歴（省略時および0を指定時は最新の集計データを返す。集計表履歴番号を指定する（%usr:totalizer_<集計表タイトル>:n のnの部分の値）
terminal_ip_address	string <IPアドレス仕様> エンドユーザ(末端)のIPアドレス

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"jsessionid": "E7D021DF2E9657C51EBA8B4B340B98FC",
"auto_login_cookie": "r109112=3822feb0b9b821～中略～b73be7a47",
"totalizer_title": "テスト集計表",
"my_area_title": "api_auth",
"history": 0,
"terminal_ip_address": "vvv.xxx.yyy.zzz"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"header_x": ["name",
"email"
],
"header_y": ["行1",
"行2"
],
"data": [["test@example.com",
"1",
"100%"
],
["不明",
"0",
"0%"
],
["全体",
"1",
"100%"
]
],
"jsessionid": "0323029CFD30EFA31C00912FC11F6D6B",
"auto_login_cookie": "r109112=3822feb～中略～92b3433dded",
"auto_login_limit": 1603334087
}

集計の実行

集計を実行します

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: sumtable/count/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
jsessionid	string <半角英数大文字> マイエリアにログインした際のセッションID（※選択必須）
auto_login_cookie	string <半角英数記号> マイエリアにログインした際のauto_login_cookieの値（※選択必須）
totalizer_title required	string <半角英数字, アンスコ, ハイフン> <= 16 集計表タイトル（集計表設定から取得可能）
my_area_title required	string <半角英数字, アンスコ, ハイフン> <= 16 マイエリアのタイトル
terminal_ip_address	string <IPアドレス仕様> エンドユーザ(末端)のIPアドレス

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"jsessionid": "E7D021DF2E9657C51EBA8B4B340B98FC",
"auto_login_cookie": "r109112=3822feb0b9b821～中略～b73be7a47",
"totalizer_title": "テスト集計表",
"my_area_title": "api_auth",
"terminal_ip_address": "vvv.xxx.yyy.zzz"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"jsessionid": "0323029CFD30EFA31C00912FC11F6D6B",
"auto_login_cookie": "r109112=3822feb～中略～92b3433dded",
"auto_login_limit": 1603334087
}

集計表のステータスを取得

集計表のステータスを取得します

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: sumtable/status/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
jsessionid	string <半角英数大文字> マイエリアにログインした際のセッションID（※選択必須）
auto_login_cookie	string <半角英数記号> マイエリアにログインした際のauto_login_cookieの値（※選択必須）
totalizer_title required	string <半角英数字, アンスコ, ハイフン> <= 16 集計表タイトル（集計表設定から取得可能）
my_area_title required	string <半角英数字, アンスコ, ハイフン> <= 16 マイエリアのタイトル
terminal_ip_address	string <IPアドレス仕様> エンドユーザ(末端)のIPアドレス

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"jsessionid": "E7D021DF2E9657C51EBA8B4B340B98FC",
"auto_login_cookie": "r109112=3822feb0b9b821～中略～b73be7a47",
"totalizer_title": "テスト集計表",
"my_area_title": "api_auth",
"terminal_ip_address": "vvv.xxx.yyy.zzz"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"status": 2,
"count_date": "2020/11/09 15:00",
"history": 1,
"who": "auto_totalize",
"jsessionid": "0323029CFD30EFA31C00912FC11F6D6B",
"auto_login_cookie": "r109112=3822feb～中略～92b3433dded",
"auto_login_limit": 1603334087
}

エクスプレス２配信

Express2配信

Express2で配信を行います。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: deliver_express2/regist/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
db_title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters データベースのタイトル
mail_field_title required	string <半角英数字, アンスコ, ハイフン> メールアドレスフィールドのタイトル
reserve_date required	string <yyyy/mm/dd HH:MM (MMは 00 or 30)> 配信予約日時。即時配信は、 now を指定する。00分と30分のみ指定可能。
subject required	string <= 128 bytes 件名
mail_type	string <text or html or multipart> メール種別。省略時はテキストメール扱い
body_text	string <body_htmlとあわせて512000byteまで> テキストの文面 (HTML不可) ※テキストメールおよびマルチパートメールでは必須
body_html	string <body_textとあわせて512000byteまで> テキストの文面 (HTMLパート) ※HTMLメールおよびマルチパートメールでは必須
from_address required	string <メールアドレス> 差出人メールアドレス
from_name	string 差出人名
reply_to	string <メールアドレス> 返信先メールアドレス
select_name	string <= 128 bytes データベースの抽出ルール名
error_field_title	string <半角英数字, アンスコ> 配信エラーフィールドのタイトル指定した場合は配信エラーの自動反映、５系配信エラーの除外はそれぞれtrueとなる。
error_auto_update	string <boolean (t or f)> 配信エラーを自動反映する。反映する=t, 反映しない=f
error_auto_exclude	string <boolean (t or f)> 配信エラーを除外する。除外する=t, 除外しない=f
error_exclude_count	integer <int32> 配信エラーを除外するエラー回数
optout_field_title	string <半角英数字, アンスコ> オプトアウトフィールドのタイトル
envelope_name	string 封筒名（識別名）
smime	integer <int32> 0 or 指定なし : 署名しない 1 : 署名する（一部ドメインを除外） 2 :署名する（全ての宛先） from_address、from_nameが両方指定されているときのみ利用可能
dkim_selector	string <半角英数字, ハイフン> DKIMセレクター名 (Dxxxxxxxx-yyyyyyy) 空文字を指定した場合は第三者署名、有効なDKIMセレクタ―を指定した場合は作成者署名で配信の設定を行う。項目指定しない場合は第三者署名となる。
standby	string <boolean (t or f)> Default: "t" スタンバイ
mobile_night_deliver	string <boolean (t or f)> Default: "t" 携帯夜間配信。配信する=t、配信しない=f。指定しない場合は標準設定。
log_extend_field_title	string <半角英数字, アンスコ, ハイフン> [ 4 .. 16 ] 配信ログ拡張。配信ログ(r0000000000.txt)に指定したフィールドの情報を付与する。整数、数字記号アルファベット(6byte、32byte)のみ指定可。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"db_title": "member",
"mail_field_title": "email",
"reserve_date": "2020/11/02 13:00",
"subject": "APIからメール配信のテスト",
"mail_type": "text ",
"body_text": "TEXTのテストメールです。\nメールの本文です。",
"body_html": "HTMLのテストメールです。",
"from_address": "test@example.com",
"from_name": "テストプログラム",
"reply_to": "reply@example.com",
"select_name": "selectRule",
"error_field_title": "errorTitle",
"error_auto_update": "f",
"error_auto_exclude": "f",
"error_exclude_count": 1,
"optout_field_title": "opt_out",
"envelope_name": "封筒名",
"smime": 0,
"dkim_selector": "D20201105-test",
"standby": "t",
"mobile_night_deliver": "t",
"log_extend_field_title": "age"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"rule_id": 129338
}

Express2配信の更新

Express2の配信を更新します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: deliver_express2/update/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
rule_id required	integer <int32> 配信ルールID (更新キー)
mail_field_title	string <半角英数字, アンスコ> メールアドレスフィールドのタイトル
reserve_date	string <yyyy/mm/dd HH:MM (MMは 00 or 30)> 配信予約日時。即時配信は、 now を指定する。00分と30分のみ指定可能。
subject	string <= 128 bytes 件名
body_text	string <body_htmlとあわせて512000byteまで> テキストの文面 (HTML不可) 項目指定がない場合は更新しない。空文字を指定した場合、入力必須に違反するためエラーとする
body_html	string <body_textとあわせて512000byteまで> テキストの文面（HTMLパート）項目指定がない場合は更新しない。空文字を指定した場合、入力必須に違反するためエラーとする
from_address	string <メールアドレス> 差出人メールアドレス
from_name	string 差出人名。項目指定がない場合は更新しない。空文字を指定すると値を削除できる。
reply_to	string <メールアドレス> 返信先メールアドレス
select_name	string <= 128 bytes データベースの抽出ルール名項目指定がない場合は更新しない。空文字を指定すると値を削除できる。
error_field_title	string <半角英数字, アンスコ> 配信エラーフィールドのタイトル項目指定がない場合は更新しない。指定した場合は配信エラーの自動反映、５系配信エラーの除外はそれぞれtrueに更新される。
error_auto_update	string <boolean (t or f)> 配信エラーを自動反映する。項目指定がない場合は更新しない。空文字を指定するとfalseと同じ動作をする。
error_auto_exclude	string <boolean (t or f)> Default: "f" 配信エラーを除外する。除外する=t, 除外しない=f 項目指定がない場合は更新しない。空文字を指定するとfalseと同じ動作をする。
error_exclude_count	string <int32> >= 1 Default: "3" 配信エラーを除外するエラー回数。項目指定がない場合は更新しない。
optout_field_title	string <半角英数字, アンスコ> オプトアウトフィールドのタイトル項目指定がない場合は更新しない。空文字を指定すると値を削除できる。
envelope_name	string 封筒名（識別名）
smime	integer <int32> 0 or 指定なし : 署名しない 1 : 署名する（一部ドメインを除外） 2 :署名する（全ての宛先） from_address、from_nameが両方指定されているときのみ利用可能
dkim_selector	string <半角英数字, ハイフン> DKIMセレクター名 (Dxxxxxxxx-yyyyyyy) 空文字を指定した場合は第三者署名、有効なDKIMセレクタ―を指定した場合は作成者署名に配信の設定を更新する。項目指定がない場合は更新しない。
standby	string <boolean (t or f)> Default: "f" スタンバイ（指定しない場合は更新しない)
mobile_night_deliver	string <boolean (t or f)> 携帯夜間配信。配信する=t、配信しない=f。指定しない場合は標準設定。
log_extend_field_title	string <半角英数字, アンスコ, ハイフン> [ 4 .. 16 ] 配信ログ拡張。配信ログ(r0000000000.txt)に指定したフィールドの情報を付与する。整数、数字記号アルファベット(6byte、32byte)のみ指定可。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"rule_id": 129338,
"mail_field_title": "email",
"reserve_date": "2020/11/02 13:00",
"subject": "メール件名",
"body_text": "メール本文",
"body_html": "メール本文",
"from_address": "test-from@example.com",
"from_name": "差出人太郎",
"reply_to": "reply@example.com",
"select_name": "rule_name",
"error_field_title": "deliverError",
"error_auto_update": "f",
"error_auto_exclude": "f",
"error_exclude_count": "3",
"optout_field_title": "OptOut",
"envelope_name": "封筒名",
"smime": 0,
"dkim_selector": "D20201105-test",
"standby": "f",
"mobile_night_deliver": "t",
"log_extend_field_title": "address"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK"
}

Express2配信の削除

Express2の配信を削除します。配信10分以内であればスプールがキャンセルされます。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: deliver_express2/cancel/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
rule_id required	integer <int32> 配信ルールID (削除キー)

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"rule_id": 129338
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK"
}

Express2配信一覧の取得

Express2の配信一覧を取得します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: deliver_express2/list/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
lines_per_page	integer <int32> [ 1 .. 1000 ] Default: 10 ページ毎のデータ行数。
page	integer <int32> >= 1 Default: 1 ページ番号。
	Array of objects 検索条件（省略時は、検索条件無し）複数行

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"lines_per_page": 10,
"page": 1,
"search_condition": [{"name": "_rule_id",
"value": "129338",
"operator": "=",
"logical_connection": "and"
}
]
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"header": ["column1",
"column2"
],
"data": [["129338",
"2020/11/10 16:58",
"テストメール配信",
"5",
"1",
"0",
"2020/11/10 16:58",
"2020/11/05 18:51",
"t",
"dbThanksMail"
]
],
"count": 10
}

指定配信ルールIDの詳細情報取得

指定された配信ルールIDの詳細情報を取得します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: deliver_express2/get/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
rule_id required	integer <int32> 配信ルールID

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"rule_id": 129338
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"header": ["_rule_id",
"db_title",
"mail_field_title"
],
"data": ["129338",
"dbTest",
"email"
]
}

サンプリング配信

サンプリング配信でメールを送信します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: deliver_express2/sampling/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature	string <半角英数字> 署名
rule_id required	integer <int32> 配信ルールID
ids required	Array of integers <= 100 items idの配列。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"rule_id": 129338,
"ids": [129339,
129340
]
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK"
}

サンクス配信

サンクスメール配信

サンクスメールを配信します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: deliver_thanks/send/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
rule_id required	integer <int32> 配信ルールID
id required	integer <int32> 宛先レコードのidフィールド

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"rule_id": 129338,
"id": 131145
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK"
}

クリックカウント

クリックカウント設定

クリックカウント設定APIです。
クリックカウントの機能概要についてはこちらをご覧ください。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: clickcount/create/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
title required	string <半角英数字, アンスコ, ハイフン> <= 16 URLのタイトル
jump_url required	string <半角英数字（http,httpsを含める）> <= 256 ジャンプ先URL。
start_date	string <yyyy/mm/dd hh:mm(指定範囲：yyyy: 2000 ~ 2037／mm: 01 ~ 12／dd: 01 ~ 31／hh: 00~23／mm: 00 or 30)> カウント開始日時。 start_dateを省略した場合は、下記の基準で設定される。・作成時刻が49分以前：作成時刻から分を切り捨てた日時の1時間前の日時・作成時刻が49分より後：作成時刻から分を切り捨てた日時（例：作成時刻が2020/4/1 10:48であれば2020/4/1 9:00、作成時刻が2020/4/1 10:50であれば2020/4/1 10:00がカウント開始日時となる。）
end_date	string <yyyy/mm/dd hh:mm(指定範囲：yyyy: 2000 ~ 2037／mm: 01 ~ 12／dd: 01 ~ 31／hh: 00~23／mm: 00 or 30)> カウント終了日時。 end_dateを省略した場合、設定値は2037/01/01 00:00
url_expiration_enabled	string <"t", "true" or "1"（他は全てfalse）> Default: "f" URLの期限を無期限かシステムデフォルト値に設定する。システムデフォルト値はメール配信後365日間。無期限設定＞メール文面設定の「URL有効期間設定」＞システムデフォルト値の順で優先される。メール配信時に有効期限が確定するため、本パラメータの変更は配信済のメール文面内URLには適用されない。
comment	string <改行（¥n）可> <= 512 クリックカウントのコメント
jump_url_before_start	string <半角英数字（http,httpsを含める）> <= 256 カウント開始日時より前にクリックされた場合のジャンプ先URL。
jump_url_after_end	string <半角英数字（http,httpsを含める）> <= 256 カウント終了日時より後にクリックされた場合のジャンプ先URL。
	object 総クリック回数を保存するDB、フィールドを設定する。 db_titleを指定する場合、field_titleも必須となる。連想配列形式。
	object 最終クリック日時を保存するDB、フィールドを設定する。 db_titleを指定する場合、field_titleも必須となる。連想配列形式。
url_params	Array of strings ジャンプ先URLにパラメータを付与する。 "url_title":ジャンプ先URLにURLタイトルを付与する。 "system_id":ジャンプ先URLにレコードIDを付与する。 "rule_id":ジャンプ先URLに配信ルールIDを付与する。
reflect_log	string <"t", "true" or "1"（他は全てfalse）> クリックカウントログをTRDBに自動反映する。反映先TRDBは、操作画面で事前設定が必要。反映先TRDBの設定が無い場合はエラーを返す。（code:945）

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"title": "testClickcount",
"jump_url": "https://example.com",
"start_date": "2020/11/04 10:00",
"end_date": "2037/01/01 00:00",
"url_expiration_enabled": "f",
"comment": "クリックカウントのコメント",
"jump_url_before_start": "https://example.com/before",
"jump_url_after_end": "https://example.com/after",
"total_count": {"db_title": "member",
"field_title": "ClickCount"
},
"last_click_date": {"db_title": "member",
"field_title": "LastClickDate"
},
"url_params": ["url_title",
"system_id",
"rule_id"
],
"reflect_log": "t"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"replace_key": "%url/https:cnt:[title]%"
}

クリックカウント設定の更新

クリックカウント設定を更新します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: clickcount/update/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
title required	string <半角英数字, アンスコ, ハイフン> <= 16 URLのタイトル
update_title required	string <半角英数字, アンスコ, ハイフン> <= 16 URLの更新タイトル
jump_url	string <半角英数字（http,httpsを含める）> <= 256 ジャンプ先URL
start_date	string <yyyy/mm/dd hh:mm(指定範囲：yyyy: 2000 ~ 2037／mm: 01 ~ 12／dd: 01 ~ 31／hh: 00~23／mm: 00 or 30)> カウント開始日時
end_date	string <yyyy/mm/dd hh:mm(指定範囲：yyyy: 2000 ~ 2037／mm: 01 ~ 12／dd: 01 ~ 31／hh: 00~23／mm: 00 or 30)> カウント終了日時
url_expiration_enabled	string <"t", "true" or "1"（他は全てfalse）> Default: "f" URLの期限を無期限かシステムデフォルト値に設定する。システムデフォルト値はメール配信後365日間。無期限設定＞メール文面設定の「URL有効期間設定」＞システムデフォルト値の順で優先される。メール配信時に有効期限が確定するため、本パラメータの変更は配信済のメール文面内URLには適用されない。
comment	string <改行（¥n）可> <= 512 クリックカウントのコメント
jump_url_before_start	string <半角英数字（http,httpsを含める）> <= 256 カウント開始日時より前にクリックされた場合のジャンプ先URL
jump_url_after_end	string <半角英数字（http,httpsを含める）> <= 256 カウント終了日時より後にクリックされた場合のジャンプ先URL
	object 総クリック回数を保存するDB、フィールドを設定する。 db_titleを指定する場合、field_titleも必須となる。連想配列形式。
	object 最終クリック日時を保存するDB、フィールドを設定する。 db_titleを指定する場合、field_titleも必須となる。連想配列形式。
url_params	Array of strings ジャンプ先URLにパラメータを付与する。 "url_title":ジャンプ先URLにURLタイトルを付与する。 "system_id":ジャンプ先URLにレコードIDを付与する。 "rule_id":ジャンプ先URLに配信ルールIDを付与する。
reflect_log	string <"t", "true" or "1"（他は全てfalse）> クリックカウントログをTRDBに自動反映する。反映先TRDBの設定が無い場合はエラーを返す。（code:945）

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"title": "testClickcount",
"update_title": "update_url",
"jump_url": "https://example.com",
"start_date": "2020/11/10 17:18:00",
"end_date": "2020/11/10 17:19:00",
"url_expiration_enabled": "f",
"comment": "クリックカウントテストコメント",
"jump_url_before_start": "https://example.com/before",
"jump_url_after_end": "https://example.com/after",
"total_count": {"db_title": "member",
"field_title": "totalClickCnt"
},
"last_click_date": {"db_title": "member",
"field_title": "clickDate"
},
"url_params": ["url_title",
"system_id",
"rule_id"
],
"reflect_log": "t"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"replace_key": "%url/https:cnt:[title]%"
}

クリックカウント設定の削除

クリックカウント設定を削除します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: clickcount/delete/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
title required	string <半角英数字, アンスコ, ハイフン> <= 16 URLタイトル

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"title": "testClickcount"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK"
}

クリックカウント設定の一覧を取得

検索条件に合致したクリックカウントの設定の一覧を取得します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: clickcount/list/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
lines_per_page	integer <int32> [ 1 .. 1000 ] Default: 10 ページ毎のデータ行数。
page	integer <int32> >= 1 Default: 1 ページ番号。
	Array of objects 検索条件（省略時は、検索条件無し）複数行

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"lines_per_page": 10,
"page": 1,
"search_condition": [{"name": "click_count_id",
"value": 47421,
"operator": "=",
"logical_connection": "and"
}
]
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"data": {"click_count_id": 0,
"field_id": 0,
"code": "f000009478",
"title": "urlTitle",
"name": "fieldName",
"type": "click_count",
"jump_url": "https://example.com",
"start_date": "2020/11/09 17:04",
"end_date": "2020/11/09 17:05",
"url_expiration_enabled": "f",
"comment": "コメント",
"jump_url_before_start": "https://example.com",
"jump_url_after_end": "https://example.com",
"total_count": "f000000023",
"last_click_date": "f000000024",
"url_params": [{"url_title": "url_title",
"system_id": 1,
"rule_id": 129338
}
],
"reflect_log": "f",
"application": "ClickCount"
}
}

クリックカウントの設定内容を1件取得

URLタイトルをキーにクリックカウントの設定内容を1件取得します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: clickcount/get/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
title required	string <半角英数字, アンスコ, ハイフン> <= 16 URLタイトル

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"title": "testClickcount"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"data": {"click_count_id": 0,
"field_id": 3,
"code": "f000009478",
"title": "url_title",
"name": "fieldName",
"type": "click_count",
"jump_url": "https://example.com",
"start_date": "2020/11/09 17:09",
"end_date": "2020/11/09 17:10",
"url_expiration_enabled": "f",
"comment": "コメント",
"jump_url_before_start": "https://example.com",
"jump_url_after_end": "https://example.com",
"total_count": "f000000000",
"last_click_date": "f000000000",
"url_params": [{"url_title": "url_title",
"system_id": 1,
"rule_id": 129338
}
],
"reflect_log": "f",
"application": "ClickCount"
}
}

ログ

配信ログファイルの作成とURLの返却

配信ログファイルの作成を行い、作成が完了したらURLを返します。ログファイル作成は非同期で行われます。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: logs/deliver/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
rule_id required	integer <int32> 配信ルールID

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"rule_id": 129338
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"deliver_type": "express",
"url": "https://example.com/spiral/deliver_log?token=010xh～中略～fa66dfd"
}

カスタムプログラム

カスタムプログラムの実行

カスタムプログラムを実行します。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: custom_program/run/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature	string <半角英数字> 署名
title required	string <半角英数字, アンスコ, ハイフン> <= 16 実行するカスタムプログラムのタイトル
args	Array of strings カスタムプログラムに渡す引数のリスト。配列

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"title": "api_program",
"args": ["[1, 2, 3]"
]
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"output": "CustomProgram\nSample\n",
"error_message": "string",
"start_date": "2020/11/04 11:12:00",
"end_date": "2020/11/04 11:13:00"
}

カスタムプログラムの実行（OpenAPI版）

OpenAPI形式でカスタムプログラムを実行します。

query Parameters

spiral_api_token required	string <半角英数字> Example: spiral_api_token=00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c APIトークン
passkey required	integer <int32> Example: passkey=1603238085 エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> Example: signature=1da61b89e479ce8f823755e4b9f080944684a656 署名
title required	string <半角英数字, アンスコ, ハイフン> <= 16 Example: title=api_program 実行するカスタムプログラムのタイトル
args	Array of strings Example: args=[1, 2, 3] カスタムプログラムに渡す引数のリスト。配列
json_param	string Example: json_param={{"id", "1"}, {"name", "Tester"}} カスタムプログラムに渡すJSON形式の引数のリスト。配列

Responses

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"output": "CustomProgram\nSample\n",
"error_message": "string",
"start_date": "2020/11/04 11:12:00",
"end_date": "2020/11/04 11:13:00"
}

カスタムプログラムのPHPスクリプト取得

カスタムプログラムのPHPスクリプトを取得します。
当APIは、アカウント毎の同時実行数は1に制限されます。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: custom_program/get_program_source/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters PHPスクリプトを取得するカスタムプログラムのタイトル

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"title": "api_program"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"source": "<?php ~~"
}

カスタムプログラムのPHPスクリプト更新

カスタムプログラムのPHPスクリプトを更新します。
当APIは、アカウント毎の同時実行数は1に制限されます。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: custom_program/update_program_source/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters PHPスクリプトを更新するカスタムプログラムのタイトル
source required	string <最大256KB、利用禁止関数、クラスの非使用> 更新するPHPスクリプト

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"title": "api_program",
"source": "<?php ***"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK"
}

カスタムプログラムの定期実行設定情報取得

カスタムプログラムの定期実行の設定情報を取得します。
当APIは、アカウント毎の同時実行数は1に制限されます。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: custom_program/get_scheduling/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters 定期実行の設定情報を取得するカスタムプログラムのタイトル

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"title": "api_program"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"scheduled": "t",
"timing": {"months": [1,
2,
12
],
"days_of_week": ["sun",
"mon"
],
"days_of_month": [1
],
"hours": [1,
2,
31
],
"minutes": [0,
15,
45
]
},
"notice_on_complete": "f"
}

カスタムプログラムの定期実行設定情報更新

カスタムプログラムの定期実行の設定情報を更新します。
当APIは、アカウント毎の同時実行数は1に制限されます。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: custom_program/update_scheduling/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
title required	string <半角英数字, アンスコ, ハイフン> <= 16 characters 定期実行の設定情報を取得するカスタムプログラムのタイトル
scheduled required	string Enum: "t" "f" 定期実行の利用設定
	object 定期実行情報「scheduled」に"t"を指定した場合のみ指定することができる。定期実行情報を更新したい場合に指定する。指定がない場合は定期実行情報の更新はされない。「timing」を指定する場合は、「months」「hours」「minutes」と「days_of_month」または「days_of_week」が必須となる。
notice_on_complete	string Enum: "t" "f" 定期実行完了時の通知メール送信設定「scheduled」に"t"を指定した場合のみ指定することができる。定期実行完了時の通知メール送信設定を更新したい場合に指定する。指定がない場合は定期実行完了時の通知メール送信設定の更新はされない。

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"title": "api_program",
"scheduled": "t",
"timing": {"months": [1,
2,
12
],
"days_of_week": ["sun",
"mon",
"sat"
],
"hours": [0,
1,
23
],
"minutes": [0,
15,
45
]
},
"notice_on_complete": "f"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK"
}

カスタムモジュール

カスタムモジュールのアップロード

カスタムモジュールをアップロードします。
なお、当APIは「multipart/form-data」形式のフォーマットを使ってリクエストする必要があります。

リクエストボディの構造について

リクエストボディは以下の２つのパートによって構成した multipart/form-data で送信します。

１パート目：「application/json」で、 REQUEST BODY SCHEMA に記載の JSON を指定します。
２パート目：「name="src"」としたアップロードするファイルデータを指定します。

※ 以下の REQUEST BODY SCHEMA では上記の１パート目の情報のみを記載しています。

具体的な記述方法の詳細は下記リンク先の「ファイル型などバイナリデータを含む場合」と、
サンプルプログラム「カスタムモジュールのアップロード（PHP）」を参照してください。

スパイラルAPIの使い方
https://support.smp.ne.jp/api-manuals/spiral_api/

カスタムモジュールのアップロード（PHP）
https://support.smp.ne.jp/programs/api-programs/custom_module1/

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: multipart/form-data
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: custom_module/upload/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
comment	string <半角英数字, アンスコ, ハイフン> <= 16 モジュールの説明
compress	string <boolean (t or f)> Zip圧縮されているかどうか。
dir	string <PATH文字列> アップするパス

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"comment": "phpファイルアップロード",
"compress": "f",
"dir": "xxxx/xxxxx"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK"
}

PUSH通知

iOSアプリにPUSH通知を送信

iOSアプリにPUSH通知を送ります。

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: push_notification/send_for_ios/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
title required	string <半角英数字, アンスコ, ハイフン> <= 16 PUSH通知設定タイトル
device_tokens required	Array of strings 配信対象のリスト。
message required	string 通知内容
badge	integer <int32> バッジ
action_key	string <半角英数字, アンスコ, ハイフン> 起動ボタンのキャプション
sound	string <半角英数字, アンスコ, ハイフン, ピリオド> 通知音のファイル名
launch_image	string <半角英数字, アンスコ, ハイフン, ピリオド> 起動画像のファイル名
localized_key	string <半角英数字, アンスコ, ハイフン> ローカライズしたときのメッセージのキー
localized_arguments	string <半角英数記号> ローカライズしたときのメッセージの引数。マップ
custom_fields	string <半角英数記号> 拡張項目。マップ

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"title": "notificationTitle",
"device_tokens": ["string"
],
"message": "string",
"badge": 0,
"action_key": "string",
"sound": "sample_sound",
"launch_image": "sample_image",
"localized_key": "string",
"localized_arguments": "string",
"custom_fields": "string"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"output": "Test_send_for_ios",
"error_message": "string",
"start_date": "2020/11/04 11:12:00",
"end_date": "2020/11/04 11:13:00"
}

AndroidアプリにPUSH通知を送信 (廃止)

本APIは廃止になりました
AndroidアプリにPUSH通知を送る場合は push_notification/send_for_fcm をご利用ください

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: push_notification/send_for_android/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
title required	string <半角英数字, アンスコ, ハイフン> <= 16 PUSH通知設定タイトル
registration_ids required	Array of strings 配信対象のリスト。
collapse_key	string <半角英数字> 端末がアイドル状態だったとき、復帰時に送られる値
data	string <半角英数字> 端末に送られるデータ

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"title": "notificationTitle",
"registration_ids": ["183245",
"183246"
],
"collapse_key": "returnFromIdle",
"data": "sendData"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"output": "Test_send_for_android",
"error_message": "string",
"start_date": "2020/11/04 11:12:00",
"end_date": "2020/11/04 11:13:00"
}

FCM経由でAndroidアプリにPUSH通知を送信

FCM経由でAndroidアプリにPUSH通知を送ります
FCMを利用しますが、iOSやWeb Pushはサポートしていません

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: push_notification/send_for_fcm/request

Request Body schema: application/json

spiral_api_token required	string <半角英数字> APIトークン
passkey required	integer <int32> エポック秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分
signature required	string <半角英数字> 署名
title required	string <半角英数字, アンダースコア, ハイフン> <= 16 SPIRALのPUSH通知設定のタイトル
data	object 端末に送られるKey-Valueペイロード map (key: string, value: string)
	object Android固有のオプション
tokens required	Array of strings <= 500 items 配信対象の端末のデバイストークン

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
"passkey": 1603238085,
"signature": "1da61b89e479ce8f823755e4b9f080944684a656",
"title": "notification1",
"data": {"sample_key1": "sample_value1",
"sample_key2": "sample_value2"
},
"android": {"collapse_key": "sample_collapse"
},
"tokens": ["dyTqHJ.....x7syns",
"eNGL16.....EQEtkI"
]
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

{"code": 0,
"message": "OK",
"start_date": "2024/11/01 00:00:00",
"end_date": "2024/11/01 00:00:00",
"success_count": 1,
"failure_count": 1,
"results": [{"status": "success",
"token": "dyTqHJ.....x7syns",
"message_id": "projects/xxxxxxxxxx/messages/xxxxxxxxxxxxxxxxxxxxxxxxxx"
},
{"status": "failed",
"token": "eNGL16.....EQEtkI",
"error_code": "PERMISSION_DENIED"
}
]
}

ロケータ

APIサーバのURLを返却

アクセスすべきAPIサーバのURLを返し、またサポートしているAPIバージョンを返す。
ロケータのURL：https://www.pi-pe.co.jp/api/locator

header Parameters

Content-Type required	string <半角英数記号> コンテントタイプを指定します。 Content-Type: application/json; charset=UTF-8
X-SPIRAL-API required	string <半角英数記号> SPIRAL ver.1 API の PATH を指定します。 X-SPIRAL-API: locator/apiserver/request

Request Body schema: application/json

spiral_api_token

required

string <半角英数字>

APIトークン

Responses

Request samples

Payload

Content type

application/json

{"spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c"
}

Response samples

200 (正常時)
200 (異常時)

Content type

application/json

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