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

はじめに

このページはSPIRAL ver.1 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 <半角英数字> (spiral_api_token)

APIトークン

passkey
required
integer <int32> (passkey)

epoch秒。APIトークンシークレットとpasskeyで署名を作成する。
署名の有効期限チェックにも使用する。有効期限は作成してから30分

signature
required
string <半角英数字> (signature)

署名

db_title
required
string <半角英数字, アンスコ, ハイフン> <= 16 characters

データベースのタイトル

required
Array of objects (_database_insert_data)

登録データ。指定しないフィールドは登録しない(NULLになる)。複数行

Responses

Request samples

Content type
application/json
{
  • "spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
  • "passkey": 1603238085,
  • "signature": "1da61b89e479ce8f823755e4b9f080944684a656",
  • "db_title": "member",
  • "data": [
    ]
}

Response samples

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 <半角英数字> (spiral_api_token)

APIトークン

passkey
required
integer <int32> (passkey)

epoch秒。APIトークンシークレットとpasskeyで署名を作成する。
署名の有効期限チェックにも使用する。有効期限は作成してから30分

signature
required
string <半角英数字> (signature)

署名

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

Content type
application/json
{
  • "spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
  • "passkey": 1603238085,
  • "signature": "1da61b89e479ce8f823755e4b9f080944684a656",
  • "db_title": "member",
  • "columns": [
    ],
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "0",
  • "message": "OK",
  • "ids": [
    ]
}

データ更新

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

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 <半角英数字> (spiral_api_token)

APIトークン

passkey
required
integer <int32> (passkey)

epoch秒。APIトークンシークレットとpasskeyで署名を作成する。
署名の有効期限チェックにも使用する。有効期限は作成してから30分

signature
required
string <半角英数字> (signature)

署名

db_title
required
string <半角英数字, アンスコ, ハイフン> <= 16 characters

データベースのタイトル

id
integer <int32>

id (id,select_name,search_conditionはANDで検索)

select_name
string <半角英数字, アンスコ, ハイフン>

抽出ルール名。search_conditionも指定されている時はANDでつなぐ。
抽出ルールに抽出結果のレコード数指定がされている場合はレコード数指定が無効になります。

Array of objects (_database_update_search_condition)

検索条件(省略時は、検索条件無し)複数行

required
Array of objects (_database_update_data)

更新データ。指定しないフィールドは更新しない。複数行

Responses

Request samples

Content type
application/json
{
  • "spiral_api_token": "00087c6gU5g2caa3983f1b5d13c6238b0fef23b41b1d7d59c29c",
  • "passkey": 1603238085,
  • "signature": "1da61b89e479ce8f823755e4b9f080944684a656",
  • "db_title": "member",
  • "id": 178120,
  • "select_name": "select_name",
  • "search_condition": [
    ],
  • "data": [
    ]
}

Response samples

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