KREISEL JSON API (202509)

Download OpenAPI specification:Download

URL: https://tricorn.co.jp/ Terms of Service

この文書は、KREISEL JSON APIの仕様について開示している資料です。

利用者は当社が別途提示する「トライコーン株式会社技術資料利用規約」に同意したものとみなします。

KREISEL API仕様書

概要

JSONフォーマットでリクエスト・レスポンスをやり取りします。
文字コードはUTF-8を利用してください。
HTTPメソッドはPOSTのみの対応とし、URLにパラメータを含むことは許容しません。
APIの引数・返り値は原則SOAP APIと同じ値とします。
API名はURLのパスで指定してください。

認証

APIトークンは Authorization ヘッダの Bearer 形式で設定してください。
APIトークンはシステム管理者がシステムメニューのAPIトークン管理にて作成可能です。
APIトークンに紐づいたアカウントには処理に必要な権限のみ付与するようにしてください。

環境情報取得 API

環境設定やバージョン情報などを取得するAPI群です。

環境名を取得

環境名を取得します。

必要オプション

なし

必要権限

なし

監査ログ

記録されません。

Authorizations:

bearerAuth

Request Body schema: application/json

このAPIはリクエストボディを必要としません。

object

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_environment_name

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_environment_name

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_environment_name

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_environment_name

Request samples

Payload

Content type

application/json

{ }

Response samples

200
4xx
5xx

Content type

application/json

{"envname": "テスト環境"
}

データベース関連 API

データベースの操作やデータ管理に関連するAPI群です。

会員データベースの一覧を取得

会員データベースの一覧および、その情報を取得します。

必要オプション

なし

必要権限

なし

監査ログ

記録されません。

備考

配列の要素は表示順です。
現在はデータベースIDの小さい順です。
アクセス権のないデータベースについては、返値に含まれません。

Authorizations:

bearerAuth

Request Body schema: application/json

object

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_member_tables

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_member_tables

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_member_tables

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_member_tables

Request samples

Payload

Content type

application/json

{ }

Response samples

200
4xx
5xx

Content type

application/json

{"member_tables": [{"id": 1,
"title": "名称",
"nums": 50
}
]
}

会員データベース項目一覧の情報を取得

指定された会員データベースの項目名および、その情報を取得します。

必要オプション

なし

必要権限

全ての権限または操作のみ

監査ログ

記録されません。

備考

項目の順番は表示順です。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

情報を取得するデータベースのID。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_member_table_elements

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_member_table_elements

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_member_table_elements

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_member_table_elements

Request samples

Payload

Content type

application/json

{"member_table_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

{"member_table_elements": [{"id": 3,
"name": "名前",
"type": "text",
"required": true,
"unique": true,
"system": false
}
]
}

特定の会員データベース項目の詳細設定を取得

指定された会員データベース項目の設定情報を取得します。

必要オプション

なし

必要権限

全ての権限または操作のみ

監査ログ

記録されません。

備考

オプション情報（返値のoption）に含まれるキー項目と値は、項目の種別ごとに異なります。詳細は「04_database-related.md」の表4-15を参照してください。
リレーション属性が付与されていない場合は、relate_to、delete_cascadeの各キーは返値に含まれません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

element_id

required

integer

設定情報を取得する項目のID。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_member_table_element_config

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_member_table_element_config

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_member_table_element_config

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_member_table_element_config

Request samples

Payload

Content type

application/json

{"element_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

{"option": {"type": "any",
"relate_to": "15",
"delete_cascade": "cascade",
"min": "1",
"max": "100",
"options": {"1": "選択肢_1",
"2": "選択肢_2"
},
"min_year": "2000",
"max_year": "2010",
"automatic": 0,
"later": 10,
"label": "ラベル",
"yes_description": "（選択）",
"no_description": "",
"allow_chars": "0123456789abcdefghijklmnopqrstuvwxyz",
"require_digit": true,
"require_alpha": false,
"require_special": false,
"min_length": 8,
"max_length": 32,
"auto_length": 8,
"encryption_key": 3,
"enable_replace_mapping": false,
"prefix": "AAA",
"suffix": "BBB",
"number_of_digits": "0",
"add_option": "1",
"standard_value": "0"
}
}

会員データベースをロックし、他の処理実行を防ぐ

指定された会員データベースを明示的にロックします。

データベースが既にこのAPIによりロックされている場合は何もしません。

必要オプション

なし

必要権限

全ての権限または操作のみ

監査ログ

データベースのロック

備考

このAPIによってロックされたデータベースは、ロックが解除されるまで、管理画面からは操作できなくなります（管理画面の上部にその旨が表示されます）。
「データベースロックによって制限される機能一覧」も参照してください。
このAPIによってロックされたデータベースについて、export_members および import_members APIは、ロックをしたユーザのみ実行可能となります。
ロックの解除し忘れに注意してください。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

ロックを行うデータベースのID。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/lock_database

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/lock_database

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/lock_database

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/lock_database

Request samples

Payload

Content type

application/json

{"member_table_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

{"result": true
}

ロックされた会員データベースのロックを解除する

lock_database APIによりロックされた会員データベースをアンロックします。 lock_database によるロック状態ではない場合、何もしません。

必要オプション

なし

必要権限

全ての権限または操作のみ

監査ログ

データベースのアンロック

備考

ロックしたユーザとアンロックを行うユーザが異なる場合でも、アンロックは可能です。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

アンロックを行うデータベースのID。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/unlock_database

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/unlock_database

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/unlock_database

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/unlock_database

Request samples

Payload

Content type

application/json

{"member_table_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

{"result": true
}

会員情報関連API

会員の登録、参照、更新、削除などを行うAPI群です。

会員情報で検索し、対応する会員IDを取得

指定された会員情報およびパスワードから、合致する会員IDを取得します。

必要オプション

なし

必要権限

全ての権限
参照のみ

監査ログ

会員の検索

備考

対象のデータベースは重複キーが設定されていなければなりません。
指定された会員情報およびパスワードの妥当性検証に失敗した場合は、合致する会員が存在しない0ではなくエラー（KR_API_F0004）を返却することに注意してください。
機種依存文字が許可されているテキスト、テキストエリア項目は機種依存文字を送信可能です。

エラー

例外コード	例外説明	状況
`KR_API_F0301`	`Multi Password Elements.`	パスワード項目が複数指定されました。
`KR_API_F0302`	`Not Unique Key or Password Elements Either.`	パスワード項目でも、キー項目でもないものが指定されました。
`KR_API_F0303`	`All Unique Key Elements Not Specified.`	全てのキー項目が指定されていません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

データベースID

required

object

キー項目および、パスワードの項目の連想配列です。

パスワードの項目のタイプは、パスワード（平文）でもパスワード（ハッシュ）でも良いです。

パスワードの項目は指定しなくても良いですが、複数指定は不可です。

項目名は e_## (##は項目ID) の形式です。

additional property	string or integer
One of string

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/lookup_member_id

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/lookup_member_id

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/lookup_member_id

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/lookup_member_id

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"member_info": {"e_12": "user@example.com",
"e_13": "ユーザ名",
"e_22": "password"
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"member_id": 15
}

指定された会員IDの会員情報を取得

指定された会員IDの会員情報（システム項目を含む）を取得します。

必要オプション

なし

必要権限

全ての権限
参照のみ

監査ログ

会員の検索

備考

「テキスト（暗号化）」項目については、ログインユーザに対する暗号項目鍵の利用権限によって取得できる値が異なります。
- 権限あり: 暗号項目鍵によって復号された値（会員の実データ）
- 権限なし: 「（暗号化されています）」の文字列
「パスワード（ハッシュ）」項目については、取得される値は必ず「******」となります。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id required	integer データベースID
member_id required	integer 会員ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_member_info

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_member_info

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_member_info

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_member_info

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"member_id": 23
}

Response samples

200
4xx
5xx

Content type

application/json

{"member_info": {"id": 132,
"regist_date": "2007-10-11 22:33:45",
"update_date": "2007-11-07 11:48:09",
"batch_date": null,
"e_4": "address@example.com",
"e_5": "k2(2#9d",
"e_6": 0,
"e_7": [1,
6
],
"e_8": false
}
}

指定した条件に合致する会員情報の一覧を取得

抽出の条件を指定して、条件に合致した会員情報の一覧を取得します。

指定された抽出条件に合致する会員情報を、 sort_key に指定された項目を order の順にソートした上で、（offset 番目から）最大 50 件取得します。

50 件以上の会員情報を取得する場合は、offset を 50 ずつずらして、繰り返しこのAPIを実行する必要があります。

なお、該当する会員の数を取得する場合は get_members_num_by_oneshot_condition を使用してください。

必要オプション

なし

必要権限

全ての権限
参照のみ
会員データ検索の権限が有効の場合

監査ログ

会員情報の検索

備考

エラーコード	エラー説明	状況
`KR_API_F0304`	`Invalid Offset.`	オフセット値が正しくありません。
`KR_API_F0229`	`Condition Is Containing Encryption Element.`	`condition_info`に「テキスト（暗号化）」項目を含めました。
`KR_API_F0230`	`This Element Is Not Allowed For Sort Key.`	`sort_key`に指定できない項目を指定しました。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

データベースID

required

object (ConditionInfo)

抽出条件の情報。

抽出条件の名称 title は無視されるため、指定しなくてもかまいません。

title

required

string

抽出条件の名称

grouping

required

boolean

Enum: true false

項目間の条件の結合方法

true: AND結合
false: OR結合

required

object

項目ごとの条件。

additional property

会員ID (object) or 登録日時 (object) or 更新日時 (object) or 一括処理日時 (object) or アップロード日時 (object) or 最終ホスト (object) or 最終REFERER (object) or 最終USER_AGENT (object) or クリックカウントフラグ (object) or その他・ユーザ定義項目 (object)

Any of

Array of items (IndividualCondition) = 2 items

項目ごとの条件を指定します。

キーは項目名（id, regist_date, e_## など）です。

値は [条件のとりかた (integer), 付加情報 (object)] の形式の配列です。

「付加情報」の構造は項目種別と「条件のとりかた」により異なります。詳しくは「抽出条件のパラメータ化」を参照してください。

[0]

integer

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 19 20 26 29

条件のとりかた。

1: 条件を指定しない
2: 条件値が対象値と完全に一致する
3: 条件値が対象値の前方（先頭基準）に含まれる
4: 条件値が対象値の後方（末尾基準）に含まれる
5: 条件値が対象値に含まれる
6: 条件値が対象値と完全に異なる
7: 条件値が対象値の前方（先頭基準）に含まれない
8: 条件値が対象値の後方（末尾基準）に含まれない
9: 条件値が対象値に含まれない
10: 対象値に何も記述されていない
11: 対象値が真
12: 対象値が偽
13: 条件値がいずれかの対象値を含む
14: 条件値が対象値に含まれない
15: 条件値と対象値の個数が等しい
16: 条件値が対象配信キャリアと等しい
17: 条件値が対象エラー回数と等しい
19: 条件値が対象アップロード日時と等しい
20: 対象値に何かしら記述されている（「データなし」の反対）
26: 対象日時が抽出実行日の前後一定期間の範囲（月単位）
29: 対象日時が抽出実行日の前後一定期間の範囲（日単位）

会員IDの配列 (object) or テキスト (object) or URL (object) or パスワード（平文） (object) or 郵便番号 (object) or 電話番号 (object) or テキストエリア (object) or 最終ホスト (object) or 最終REFERER (object) or 自動採番 (object) or メールアドレス (object) or 整数 (object) or 単一選択 (object) or 都道府県 (object) or 性別 (object) or 未既婚 (object) or はい/いいえ (object) or 複数選択肢 (object) or 日付 (object) or 登録日時 (object) or 更新日時 (object) or 一括処理日時 (object) or Array of クリックカウントフラグ (objects) or アップロード日時 (object) or 付加情報なし (object)

付加情報オブジェクト。

その構造は「条件のとりかた」と項目種別によって異なります。

One of

ids

required

Array of integers

会員IDの配列

offset

required

integer

何番目の会員情報から取得するかのオフセット。

最初の会員情報をオフセット0とします。

sort_key

required

integer

ソートの対象となる項目のID。

会員IDの場合は0を指定します。

order

required

boolean

Enum: true false

ソートの順番。

true: 昇順
false: 降順

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_member_infos_by_oneshot_condition

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_member_infos_by_oneshot_condition

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_member_infos_by_oneshot_condition

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_member_infos_by_oneshot_condition

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"condition_info": {"title": "APIで作成された抽出条件",
"grouping": true,
"conditions": {"regist_date": [5,
{"start_date": "2009-01-01"
}
],
"e_4": [4,
{"value": "@tricorn.co.jp"
}
],
"e_6": [5,
{"values": [1
]
}
],
"e_7": [13,
{"options": [3,
5
]
}
],
"e_11": [26,
{"calc_start_value": -1,
"calc_end_value": 1
}
]
}
},
"offset": 0,
"sort_key": 0,
"order": true
}

Response samples

200
4xx
5xx

Content type

application/json

{"member_infos": [{"id": 132,
"regist_date": "2007-10-11 22:33:45",
"update_date": "2007-11-07 11:48:09",
"batch_date": null,
"e_4": "address@example.com",
"e_5": "k2(2#9d",
"e_6": 0,
"e_7": [1,
6
],
"e_8": false
}
]
}

抽出条件を指定して会員情報の一覧を取得

既存の抽出条件を指定して、条件に合致した会員情報の一覧を取得します。

動作の詳細は get_member_infos_by_oneshot_condition と同様です。

必要オプション

なし

必要権限

全ての権限または参照のみ

監査ログ

会員情報の一覧検索

備考

「テキスト（暗号化）」項目については、ログインユーザに対する暗号項目鍵の利用権限によって取得できる値が異なります。
- 権限あり: 暗号項目鍵によって復号された値（会員の実データ）
- 権限なし: 「（暗号化されています）」の文字列
「パスワード（ハッシュ）」項目については、取得される値は必ず「******」となります。
sort_keyに「テキスト（暗号化）」項目は指定できません。

エラー

例外コード	例外説明	状況
`KR_API_F0304`	`Invalid Offset.`	オフセット値が正しくありません。
`KR_API_F0230`	`This Element Is Not Allowed For Sort Key.`	`sort_key`に指定できない項目を指定しました。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id required	integer データベースID
condition_id required	integer 抽出条件ID
offset required	integer 何番目の会員情報から取得するかのオフセット。最初の会員情報をオフセット`0`とします。
sort_key required	integer ソートの対象となる項目のID。会員IDの場合は`0`を指定します。
order required	boolean ソートの順番。 `true`: 昇順 `false`: 降順

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_member_infos_by_condition

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_member_infos_by_condition

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_member_infos_by_condition

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_member_infos_by_condition

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"condition_id": 5,
"offset": 0,
"sort_key": 0,
"order": true
}

Response samples

200
4xx
5xx

Content type

application/json

{"member_infos": [{"id": 132,
"regist_date": "2007-10-11 22:33:45",
"update_date": "2007-11-07 11:48:09",
"batch_date": null,
"e_4": "address@example.com",
"e_5": "k2(2#9d",
"e_6": 0,
"e_7": [1,
6
],
"e_8": false
}
]
}

指定した条件に合致する会員数を取得

抽出の条件を指定して、条件に合致した会員の件数を取得します。

必要オプション

なし

必要権限

全ての権限または参照のみまたは会員データ検索の権限が有効の場合

監査ログ

会員情報の検索

エラー

例外コード	例外説明	状況
`KR_API_F0229`	`Condition Is Containing Encryption Element.`	`condition_info`に「テキスト（暗号化）」項目を含めました。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

データベースID

required

object (ConditionInfo)

抽出条件の情報。

抽出条件の名称 title は無視されるため、指定しなくてもかまいません。

title

required

string

抽出条件の名称

grouping

required

boolean

Enum: true false

項目間の条件の結合方法

true: AND結合
false: OR結合

required

object

項目ごとの条件。

additional property

会員ID (object) or 登録日時 (object) or 更新日時 (object) or 一括処理日時 (object) or アップロード日時 (object) or 最終ホスト (object) or 最終REFERER (object) or 最終USER_AGENT (object) or クリックカウントフラグ (object) or その他・ユーザ定義項目 (object)

Any of

Array of items (IndividualCondition) = 2 items

項目ごとの条件を指定します。

キーは項目名（id, regist_date, e_## など）です。

値は [条件のとりかた (integer), 付加情報 (object)] の形式の配列です。

「付加情報」の構造は項目種別と「条件のとりかた」により異なります。詳しくは「抽出条件のパラメータ化」を参照してください。

[0]

integer

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 19 20 26 29

条件のとりかた。

1: 条件を指定しない
2: 条件値が対象値と完全に一致する
3: 条件値が対象値の前方（先頭基準）に含まれる
4: 条件値が対象値の後方（末尾基準）に含まれる
5: 条件値が対象値に含まれる
6: 条件値が対象値と完全に異なる
7: 条件値が対象値の前方（先頭基準）に含まれない
8: 条件値が対象値の後方（末尾基準）に含まれない
9: 条件値が対象値に含まれない
10: 対象値に何も記述されていない
11: 対象値が真
12: 対象値が偽
13: 条件値がいずれかの対象値を含む
14: 条件値が対象値に含まれない
15: 条件値と対象値の個数が等しい
16: 条件値が対象配信キャリアと等しい
17: 条件値が対象エラー回数と等しい
19: 条件値が対象アップロード日時と等しい
20: 対象値に何かしら記述されている（「データなし」の反対）
26: 対象日時が抽出実行日の前後一定期間の範囲（月単位）
29: 対象日時が抽出実行日の前後一定期間の範囲（日単位）

会員IDの配列 (object) or テキスト (object) or URL (object) or パスワード（平文） (object) or 郵便番号 (object) or 電話番号 (object) or テキストエリア (object) or 最終ホスト (object) or 最終REFERER (object) or 自動採番 (object) or メールアドレス (object) or 整数 (object) or 単一選択 (object) or 都道府県 (object) or 性別 (object) or 未既婚 (object) or はい/いいえ (object) or 複数選択肢 (object) or 日付 (object) or 登録日時 (object) or 更新日時 (object) or 一括処理日時 (object) or Array of クリックカウントフラグ (objects) or アップロード日時 (object) or 付加情報なし (object)

付加情報オブジェクト。

その構造は「条件のとりかた」と項目種別によって異なります。

One of

ids

required

Array of integers

会員IDの配列

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_members_num_by_oneshot_condition

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_members_num_by_oneshot_condition

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_members_num_by_oneshot_condition

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_members_num_by_oneshot_condition

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"condition_info": {"title": "APIで作成された抽出条件",
"grouping": true,
"conditions": {"regist_date": [5,
{"start_date": "2009-01-01"
}
],
"e_4": [4,
{"value": "@tricorn.co.jp"
}
],
"e_6": [5,
{"values": [1
]
}
],
"e_7": [13,
{"options": [3,
5
]
}
],
"e_11": [26,
{"calc_start_value": -1,
"calc_end_value": 1
}
]
}
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"members_num": 6
}

抽出条件に合致する会員数を取得

既存の抽出条件を指定して、条件に合致した会員の件数を取得します。

動作の詳細は get_members_num_by_oneshot_condition と同様です。

必要オプション

なし

必要権限

全ての権限
参照のみ

監査ログ

会員情報の一覧検索

エラー

例外コード	例外説明	状況
`KR_API_F0304`	`Invalid Offset.`	オフセット値が正しくありません。（このAPIではoffset引数がないため、通常発生しないはずですが、ドキュメントに記載があるため含めます）

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id required	integer データベースID
condition_id required	integer 抽出条件ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_members_num_by_condition

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_members_num_by_condition

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_members_num_by_condition

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_members_num_by_condition

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"condition_id": 5
}

Response samples

200
4xx
5xx

Content type

application/json

{"members_num": 6
}

新しい会員を登録

新しい会員をデータベースに登録します。

member_infoは全てを指定する必要はありません。指定しなかった項目は未記入として扱われます。

パスワード（平文）項目・パスワード（ハッシュ）項目について指定なし、未記入は自動生成となります。

必要オプション

なし

必要権限

全ての権限

監査ログ

会員の追加

備考

このAPIによって会員が登録された場合、システム項目の一部は以下のように設定されます。
- 登録日時: 登録が行われた日時
- 最終USER_AGENT: APIクライアントのUSER_AGENT （存在しない場合は空文字列）
- 最終REFERER: APIクライアントのREFERER
- 最終ホスト: APIクライアント接続元のホスト名またはIPアドレス
機種依存文字が許可されているテキスト、テキストエリア項目は機種依存文字を送信可能です。
「テキスト（暗号化）」項目が存在するデータベースにおいて、暗号項目鍵の利用権限を持たないログインユーザが会員登録を行った場合は登録不可です。
必須ではない「テキスト（暗号化）」項目に対して空文字を指定、もしくは項目を指定しなかった場合は、空文字を暗号化したデータが登録されます。
自動採番項目は、送信した値に関わらず、データベース項目の設定値に従って自動生成された値が登録されます。

エラー

例外コード	例外説明	状況
`KR_API_F0122`	`No Any Element.`	項目が存在しません。
`KR_API_F0116`	`Action Is Not Finished.`	登録が完了しませんでした（送信情報にエラーがあった）。
`KR_API_F0117`	`Member Already Exists.`	重複エラーが発生しました。
`KR_API_F0228`	`Exist Not Authorized Encryption Element.`	「テキスト（暗号化）」項目が存在するDBで、暗号項目鍵の利用権限がないユーザが登録を行いました。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

データベースID

required

object (MemberInfo)

会員情報。項目名をキーとする連想配列として表現されます。キーの詳細は「会員情報のパラメータ化」を参照してください。ユーザ定義項目は e_## (##は項目ID) というキーになります。

id	integer 会員ID
regist_date	string^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$ 登録日時
update_date	string^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$ 更新日時
batch_date	string or null^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$ 一括処理日時
upload_date	string or null^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$ アップロード日時
last_host	string or null 最終ホスト
last_referer	string or null 最終REFERER
last_useragent	string or null 最終USER_AGENT
additional property	string or integer or boolean or Array of integers ユーザ定義項目。キーは `e_##` (##は項目ID)です。値の型は項目タイプに依存します。テキスト、テキストエリア、メールアドレス、URL、郵便番号、電話番号、自動採番、テキスト（暗号化）、パスワード（ハッシュ）: `string` 整数: `integer` 単一選択、都道府県、性別、未既婚、はい/いいえ: `integer` (選択肢ID) 複数選択: `array` of `integer` (選択肢ID) 日付: `string` (YYYY-MM-DD) 選択: `boolean` パスワード（平文）: `string`
One of string ユーザ定義項目。キーは `e_##` (##は項目ID)です。値の型は項目タイプに依存します。テキスト、テキストエリア、メールアドレス、URL、郵便番号、電話番号、自動採番、テキスト（暗号化）、パスワード（ハッシュ）: `string` 整数: `integer` 単一選択、都道府県、性別、未既婚、はい/いいえ: `integer` (選択肢ID) 複数選択: `array` of `integer` (選択肢ID) 日付: `string` (YYYY-MM-DD) 選択: `boolean` パスワード（平文）: `string`

Responses

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"member_info": {"id": 132,
"regist_date": "2007-10-11 22:33:45",
"update_date": "2007-11-07 11:48:09",
"batch_date": null,
"e_4": "address@example.com",
"e_5": "k2(2#9d",
"e_6": 0,
"e_7": [1,
6
],
"e_8": false
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"member_id": 15
}

既存の会員情報を更新

指定した会員の登録情報を更新します。

member_infoは全てを指定する必要はありません。指定しなかった項目は変更なしとして扱われます。

パスワード（平文）項目・パスワード（ハッシュ）項目について未記入（空文字列）を指定した場合は自動生成となります。

必要オプション

なし

必要権限

全ての権限

監査ログ

会員の更新

備考

このAPIによって会員が更新された場合、システム項目の一部は以下のように設定されます。
- 更新日時: 更新が行われた日時
- 最終USER_AGENT: APIクライアントのUSER_AGENT （存在しない場合は空文字列）
- 最終REFERER: APIクライアントのREFERER
- 最終ホスト: APIクライアント接続元のホスト名またはIPアドレス
機種依存文字が許可されているテキスト、テキストエリア項目は機種依存文字を送信可能です。
「テキスト（暗号化）」項目が存在するデータベースにおいて、暗号項目鍵の利用権限を持たないログインユーザが会員の更新を行った場合は更新不可です。
必須ではない「テキスト（暗号化）」項目に対して空文字を指定した場合は、空文字を暗号化したデータで更新されます。
自動採番項目は変更することが出来ません。

エラー

例外コード	例外説明	状況
`KR_API_F0116`	`Action Is Not Finished.`	更新が完了しませんでした（送信情報にエラーがあった）。
`KR_API_F0117`	`Member Already Exists.`	重複エラーが発生しました。
`KR_API_F0228`	`Exist Not Authorized Encryption Element.`	「テキスト（暗号化）」項目が存在するDBで、暗号項目鍵の利用権限がないユーザが更新を行いました。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

データベースID

member_id

required

integer

会員ID

required

object (MemberInfo)

会員情報。項目名をキーとする連想配列として表現されます。キーの詳細は「会員情報のパラメータ化」を参照してください。ユーザ定義項目は e_## (##は項目ID) というキーになります。

id	integer 会員ID
regist_date	string^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$ 登録日時
update_date	string^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$ 更新日時
batch_date	string or null^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$ 一括処理日時
upload_date	string or null^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$ アップロード日時
last_host	string or null 最終ホスト
last_referer	string or null 最終REFERER
last_useragent	string or null 最終USER_AGENT
additional property	string or integer or boolean or Array of integers ユーザ定義項目。キーは `e_##` (##は項目ID)です。値の型は項目タイプに依存します。テキスト、テキストエリア、メールアドレス、URL、郵便番号、電話番号、自動採番、テキスト（暗号化）、パスワード（ハッシュ）: `string` 整数: `integer` 単一選択、都道府県、性別、未既婚、はい/いいえ: `integer` (選択肢ID) 複数選択: `array` of `integer` (選択肢ID) 日付: `string` (YYYY-MM-DD) 選択: `boolean` パスワード（平文）: `string`
One of string ユーザ定義項目。キーは `e_##` (##は項目ID)です。値の型は項目タイプに依存します。テキスト、テキストエリア、メールアドレス、URL、郵便番号、電話番号、自動採番、テキスト（暗号化）、パスワード（ハッシュ）: `string` 整数: `integer` 単一選択、都道府県、性別、未既婚、はい/いいえ: `integer` (選択肢ID) 複数選択: `array` of `integer` (選択肢ID) 日付: `string` (YYYY-MM-DD) 選択: `boolean` パスワード（平文）: `string`

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/update_member

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/update_member

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/update_member

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/update_member

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"member_id": 5,
"member_info": {"id": 132,
"regist_date": "2007-10-11 22:33:45",
"update_date": "2007-11-07 11:48:09",
"batch_date": null,
"e_4": "address@example.com",
"e_5": "k2(2#9d",
"e_6": 0,
"e_7": [1,
6
],
"e_8": false
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"result": true
}

指定された会員情報を削除

指定した会員の登録情報を削除します。

必要オプション

なし

必要権限

全ての権限

監査ログ

会員の削除

備考

「テキスト（暗号化）」項目が存在するデータベースにおいて、暗号項目鍵の利用権限を持たないログインユーザが会員の削除を行った場合でも削除可能です（利用権限によらず削除できます）。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id required	integer データベースID
member_id required	integer 会員ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/delete_member

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/delete_member

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/delete_member

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/delete_member

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"member_id": 5
}

Response samples

200
4xx
5xx

Content type

application/json

{"result": true
}

抽出条件関連 API

データ抽出のための条件設定や管理を行うAPI群です。

新しい抽出条件を追加

新しい抽出条件を指定したデータベースに登録します。

必要オプション

なし

必要権限

全てのアクセス権または作業のみ

監査ログ

抽出条件の追加

エラー

例外コード	例外説明	状況
`KR_API_F0229`	`Condition Is Containing Encryption Element.`	`condition_info`に「テキスト（暗号化）」項目を含めました。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

データベースID

required

object (ConditionInfo)

抽出条件の情報。

「抽出条件のパラメータ化」を参照してください。

title

required

string

抽出条件の名称

grouping

required

boolean

Enum: true false

項目間の条件の結合方法

true: AND結合
false: OR結合

required

object

項目ごとの条件。

additional property

会員ID (object) or 登録日時 (object) or 更新日時 (object) or 一括処理日時 (object) or アップロード日時 (object) or 最終ホスト (object) or 最終REFERER (object) or 最終USER_AGENT (object) or クリックカウントフラグ (object) or その他・ユーザ定義項目 (object)

Any of

Array of items (IndividualCondition) = 2 items

項目ごとの条件を指定します。

キーは項目名（id, regist_date, e_## など）です。

値は [条件のとりかた (integer), 付加情報 (object)] の形式の配列です。

「付加情報」の構造は項目種別と「条件のとりかた」により異なります。詳しくは「抽出条件のパラメータ化」を参照してください。

[0]

integer

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 19 20 26 29

条件のとりかた。

1: 条件を指定しない
2: 条件値が対象値と完全に一致する
3: 条件値が対象値の前方（先頭基準）に含まれる
4: 条件値が対象値の後方（末尾基準）に含まれる
5: 条件値が対象値に含まれる
6: 条件値が対象値と完全に異なる
7: 条件値が対象値の前方（先頭基準）に含まれない
8: 条件値が対象値の後方（末尾基準）に含まれない
9: 条件値が対象値に含まれない
10: 対象値に何も記述されていない
11: 対象値が真
12: 対象値が偽
13: 条件値がいずれかの対象値を含む
14: 条件値が対象値に含まれない
15: 条件値と対象値の個数が等しい
16: 条件値が対象配信キャリアと等しい
17: 条件値が対象エラー回数と等しい
19: 条件値が対象アップロード日時と等しい
20: 対象値に何かしら記述されている（「データなし」の反対）
26: 対象日時が抽出実行日の前後一定期間の範囲（月単位）
29: 対象日時が抽出実行日の前後一定期間の範囲（日単位）

会員IDの配列 (object) or テキスト (object) or URL (object) or パスワード（平文） (object) or 郵便番号 (object) or 電話番号 (object) or テキストエリア (object) or 最終ホスト (object) or 最終REFERER (object) or 自動採番 (object) or メールアドレス (object) or 整数 (object) or 単一選択 (object) or 都道府県 (object) or 性別 (object) or 未既婚 (object) or はい/いいえ (object) or 複数選択肢 (object) or 日付 (object) or 登録日時 (object) or 更新日時 (object) or 一括処理日時 (object) or Array of クリックカウントフラグ (objects) or アップロード日時 (object) or 付加情報なし (object)

付加情報オブジェクト。

その構造は「条件のとりかた」と項目種別によって異なります。

One of

ids

required

Array of integers

会員IDの配列

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/add_condition

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/add_condition

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/add_condition

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/add_condition

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"condition_info": {"title": "APIで作成された抽出条件",
"grouping": true,
"conditions": {"regist_date": [5,
{"start_date": "2009-01-01"
}
],
"e_4": [4,
{"value": "@tricorn.co.jp"
}
],
"e_6": [5,
{"values": [1
]
}
],
"e_7": [13,
{"options": [3,
5
]
}
],
"e_11": [26,
{"calc_start_value": -1,
"calc_end_value": 1
}
]
}
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"condition_id": 1
}

指定された抽出条件を削除

指定された抽出条件を削除します。

必要オプション

なし

必要権限

全てのアクセス権または作業のみ

監査ログ

抽出条件の削除

エラー

例外コード	例外説明	状況
`KR_API_F0104`	`Condition Is Used.`	指定された抽出条件は使用されています。

Authorizations:

bearerAuth

Request Body schema: application/json
required

condition_id

required

integer

削除する抽出条件ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/delete_condition

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/delete_condition

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/delete_condition

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/delete_condition

Request samples

Payload

Content type

application/json

{"condition_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

{"result": true
}

現在の抽出条件一覧を取得

指定されたデータベースの抽出条件の一覧を取得します。

必要オプション

なし

必要権限

全てのアクセス権
作業のみ
参照のみ

監査ログ

記録されません。

備考

アクセス権限の抽出条件で、利用不可に設定されている抽出条件は取得されません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

データベースID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_conditions

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_conditions

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_conditions

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_conditions

Request samples

Payload

Content type

application/json

{"member_table_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

{"conditions": [{"id": 1,
"title": "（全員）",
"predefined": "all"
}
]
}

メール文面関連 API

メールテンプレートの作成、編集、管理を行うAPI群です。

新しいメール文面を追加

メール文面を指定されたデータベースに登録します。

必要オプション

メール

必要権限

全てのアクセス権または作業のみ

監査ログ

メール文面追加

備考

配信時にメール文面内のURLの置換は完全一致で行われます。例えばメール文面に"http://www.tricorn.co.jp/"、クリックカウント情報に"http://www.tricorn.co.jp"を指定した場合はクリックカウントとしては置換されません。
au版iPhoneに半角カナと絵文字を同時に送信すると、絵文字が正しく表示されない場合があります。
メール文面に「テキスト（暗号化）」項目の差込記号を含めた場合は、メール機能に対する暗号項目鍵の会員利用権限によって置換される値が異なります。
- 権限あり: 暗号項目鍵によって復号された値（会員の実データ）
- 権限なし: 「（暗号化されています）」の文字列
mail_info 内の text_part は type が 1（テキストメール）または 3（マルチパートメール）の場合に必須です。
mail_info 内の html_part は type が 2（HTMLメール）または 3（マルチパートメール）の場合に必須です。

エラー

例外コード	例外説明	状況
`KR_API_F0232`	`Can't use list_unsubscribe url symbol.`	`##list_unsubscribe_url##`の差し込み記号は使えません

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

データベースID

required

object (MailInfo)

メール文面情報。

allow_hankana

boolean

Default: false

true の場合、from_desc, reply_desc, subject, text_part, html_partに半角カナを含めることが可能になります。 falseの場合に半角カナが含まれていると、例外が発生します。

type

required

integer

Enum: 1 2 3

メール種別

1: テキストメール
2: HTMLメール
3: マルチパートメール

from

required

string

Fromに指定するアドレス

from_desc

string

Default: ""

Fromの名称

reply

string or null

Default: ""

Reply-Toに指定するアドレス

reply_desc

string

Default: ""

Reply-Toの名称

subject

required

string

Subject

text_part

string

Default: ""

テキストパート。

typeが1（テキストメール）または3 （マルチパートメール）の場合に必須です。

本文中1行の長さは998バイトを超えてはいけません。正しく送信できない可能性があります。（RFC821）

html_part

string

Default: ""

HTMLパート。

typeが2（HTMLメール）または3（マルチパートメール）の場合に必須です。

本文中1行の長さは998バイトを超えてはいけません。正しく送信できない可能性があります。（RFC821）

Array of objects (ClickCountUrlInfoRequest)

Default: []

取得するクリックカウントのURL情報の配列

Array

url required	string クリックカウントのURL
days	integer [ 1 .. 30 ] Default: 7 有効期限（日）。1日以上30日以内です。
outdated_url	string or null 期間外の場合のリダイレクト先URL。指定がない場合は`url`の値。空文字列を指定した場合はNot Foundとなります。

open_clickcount

boolean

Default: false

開封率クリックカウントを取得するかどうか（HTMLメール、マルチパートメールのみ有効）

object

List-Unsubscribeヘッダの設定。

pattern	string Default: "0" Enum: "0" "1" "2" "3" パターン: `"0"`: 無効 `"1"`: 有効（登録解除URLを自動生成） `"2"`: 有効（URL指定） `"3"`: 有効（メールアドレス指定）
url	string URL (patternが`"2"`の場合に必須)
email	string メールアドレス (patternが`"3"`の場合に必須)

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/add_mail_message

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/add_mail_message

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/add_mail_message

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/add_mail_message

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"mail_info": {"allow_hankana": false,
"type": 1,
"from": "sales@tricorn.co.jp",
"from_desc": "TRICORN セールス",
"reply": "contact@tricorn.co.jp",
"reply_desc": "TRICORN お問い合わせ",
"subject": "件名",
"text_part": "",
"html_part": "",
"clickcounts": [ ],
"open_clickcount": false,
"list_unsubscribe": {"pattern": "2",
"url": "https://www.tricorn.co.jp"
}
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"message_id": 1
}

指定されたメール文面を削除

指定されたメール文面を削除します。

ただし、削除可能なメール文面は通常配信用のメール文面のみとし、該当のメール文面が配信予約中の場合も削除不可とします。

必要オプション

メール

必要権限

全てのアクセス権または作業のみ

監査ログ

メール文面削除

エラー

例外コード	例外説明	状況
`KR_API_F0102`	`MailMessage Is Locked.`	指定されたメール文面は配信予約中のため、ロックされています。
`KR_API_F0211`	`MailMessage Is Not For Delivery.`	指定されたメール文面は通常配信のメールではありません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

message_id

required

integer

削除する文面ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/delete_mail_message

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/delete_mail_message

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/delete_mail_message

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/delete_mail_message

Request samples

Payload

Content type

application/json

{"message_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

{"result": true
}

エージェント配信用のメール文面を追加

エージェント配信用メール文面を指定されたデータベースに登録します。

引数のmail_infoの詳細はadd_mail_messageと同様です。

必要オプション

メール

必要権限

全てのアクセス権または操作のみ

監査ログ

メール文面追加

備考

配信時にメール文面内のURLの置換は完全一致で行われます。
au版iPhoneに半角カナと絵文字を同時に送信すると、絵文字が正しく表示されない場合があります。
メール文面に「テキスト（暗号化）」項目の差込記号を含めた場合は、メール機能に対する暗号項目鍵の会員利用権限によって置換される値が異なります。
mail_info 内の text_part は type が 1（テキストメール）または 3（マルチパートメール）の場合に必須です。
mail_info 内の html_part は type が 2（HTMLメール）または 3（マルチパートメール）の場合に必須です。

エラー

例外コード	例外説明	状況
`KR_API_F0232`	`Can't use list_unsubscribe url symbol.`	`##list_unsubscribe_url##`の差し込み記号は使えません

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

データベースID

required

object (MailInfo)

メール文面情報。

allow_hankana

boolean

Default: false

true の場合、from_desc, reply_desc, subject, text_part, html_partに半角カナを含めることが可能になります。 falseの場合に半角カナが含まれていると、例外が発生します。

type

required

integer

Enum: 1 2 3

メール種別

1: テキストメール
2: HTMLメール
3: マルチパートメール

from

required

string

Fromに指定するアドレス

from_desc

string

Default: ""

Fromの名称

reply

string or null

Default: ""

Reply-Toに指定するアドレス

reply_desc

string

Default: ""

Reply-Toの名称

subject

required

string

Subject

text_part

string

Default: ""

テキストパート。

typeが1（テキストメール）または3 （マルチパートメール）の場合に必須です。

本文中1行の長さは998バイトを超えてはいけません。正しく送信できない可能性があります。（RFC821）

html_part

string

Default: ""

HTMLパート。

typeが2（HTMLメール）または3（マルチパートメール）の場合に必須です。

本文中1行の長さは998バイトを超えてはいけません。正しく送信できない可能性があります。（RFC821）

Array of objects (ClickCountUrlInfoRequest)

Default: []

取得するクリックカウントのURL情報の配列

Array

url required	string クリックカウントのURL
days	integer [ 1 .. 30 ] Default: 7 有効期限（日）。1日以上30日以内です。
outdated_url	string or null 期間外の場合のリダイレクト先URL。指定がない場合は`url`の値。空文字列を指定した場合はNot Foundとなります。

open_clickcount

boolean

Default: false

開封率クリックカウントを取得するかどうか（HTMLメール、マルチパートメールのみ有効）

object

List-Unsubscribeヘッダの設定。

pattern	string Default: "0" Enum: "0" "1" "2" "3" パターン: `"0"`: 無効 `"1"`: 有効（登録解除URLを自動生成） `"2"`: 有効（URL指定） `"3"`: 有効（メールアドレス指定）
url	string URL (patternが`"2"`の場合に必須)
email	string メールアドレス (patternが`"3"`の場合に必須)

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/add_mail_message_for_agent_program

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/add_mail_message_for_agent_program

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/add_mail_message_for_agent_program

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/add_mail_message_for_agent_program

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"mail_info": {"allow_hankana": false,
"type": 1,
"from": "sales@tricorn.co.jp",
"from_desc": "TRICORN セールス",
"reply": "contact@tricorn.co.jp",
"reply_desc": "TRICORN お問い合わせ",
"subject": "件名",
"text_part": "",
"html_part": "",
"clickcounts": [ ],
"open_clickcount": false,
"list_unsubscribe": {"pattern": "2",
"url": "https://www.tricorn.co.jp"
}
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"message_id": 1
}

エージェント配信用のメール文面を更新

指定されたエージェント配信用メール文面を更新します。

mail_infoで指定されなかった任意項目はデフォルト値で更新されます。

mail_infoの詳細はadd_mail_messageと同様です。

必要オプション

メール

必要権限

全てのアクセス権
操作のみ

監査ログ

メール文面更新

備考

稼働中のエージェント配信の文面も更新可能ですが、配信タイミングによっては更新後の文面が反映されない可能性があります。
メール文面に「テキスト（暗号化）」項目の差込記号を含めた場合は、メール機能に対する暗号項目鍵の会員利用権限によって置換される値が異なります。
mail_info 内の text_part は type が 1（テキストメール）または 3（マルチパートメール）の場合に必須です。
mail_info 内の html_part は type が 2（HTMLメール）または 3（マルチパートメール）の場合に必須です。

エラー

例外コード	例外説明	状況
`KR_API_F0225`	`MailMessage Is Not For Agent Delivery.`	指定された文面はエージェント配信用ではありません。
`KR_API_F0226`	`Can't Update Decomail MailMessage.`	デコメール文面はこのAPIで更新できません。
`KR_API_F0232`	`Can't use list_unsubscribe url symbol.`	`##list_unsubscribe_url##`の差し込み記号は使えません

Authorizations:

bearerAuth

Request Body schema: application/json
required

mail_message_id

required

integer

更新するエージェント配信用メール文面のID

required

object (MailInfo)

メール文面情報。

allow_hankana

boolean

Default: false

true の場合、from_desc, reply_desc, subject, text_part, html_partに半角カナを含めることが可能になります。 falseの場合に半角カナが含まれていると、例外が発生します。

type

required

integer

Enum: 1 2 3

メール種別

1: テキストメール
2: HTMLメール
3: マルチパートメール

from

required

string

Fromに指定するアドレス

from_desc

string

Default: ""

Fromの名称

reply

string or null

Default: ""

Reply-Toに指定するアドレス

reply_desc

string

Default: ""

Reply-Toの名称

subject

required

string

Subject

text_part

string

Default: ""

テキストパート。

typeが1（テキストメール）または3 （マルチパートメール）の場合に必須です。

本文中1行の長さは998バイトを超えてはいけません。正しく送信できない可能性があります。（RFC821）

html_part

string

Default: ""

HTMLパート。

typeが2（HTMLメール）または3（マルチパートメール）の場合に必須です。

本文中1行の長さは998バイトを超えてはいけません。正しく送信できない可能性があります。（RFC821）

Array of objects (ClickCountUrlInfoRequest)

Default: []

取得するクリックカウントのURL情報の配列

Array

url required	string クリックカウントのURL
days	integer [ 1 .. 30 ] Default: 7 有効期限（日）。1日以上30日以内です。
outdated_url	string or null 期間外の場合のリダイレクト先URL。指定がない場合は`url`の値。空文字列を指定した場合はNot Foundとなります。

open_clickcount

boolean

Default: false

開封率クリックカウントを取得するかどうか（HTMLメール、マルチパートメールのみ有効）

object

List-Unsubscribeヘッダの設定。

pattern	string Default: "0" Enum: "0" "1" "2" "3" パターン: `"0"`: 無効 `"1"`: 有効（登録解除URLを自動生成） `"2"`: 有効（URL指定） `"3"`: 有効（メールアドレス指定）
url	string URL (patternが`"2"`の場合に必須)
email	string メールアドレス (patternが`"3"`の場合に必須)

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/update_mail_message_for_agent_program

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/update_mail_message_for_agent_program

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/update_mail_message_for_agent_program

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/update_mail_message_for_agent_program

Request samples

Payload

Content type

application/json

{"mail_message_id": 1,
"mail_info": {"allow_hankana": false,
"type": 1,
"from": "sales@tricorn.co.jp",
"from_desc": "TRICORN セールス",
"reply": "contact@tricorn.co.jp",
"reply_desc": "TRICORN お問い合わせ",
"subject": "件名",
"text_part": "",
"html_part": "",
"clickcounts": [ ],
"open_clickcount": false,
"list_unsubscribe": {"pattern": "2",
"url": "https://www.tricorn.co.jp"
}
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"result": true
}

エージェント配信用のメール文面を削除

指定されたエージェント配信用メール文面を削除します。

ただし、該当のメール文面が稼働中のエージェント配信で使用されている場合は削除不可とします。

必要オプション

メール

必要権限

全てのアクセス権または操作のみ

監査ログ

メール文面削除

エラー

例外コード	例外説明	状況
`KR_API_F0102`	`MailMessage Is Locked.`	指定されたメール文面はエージェント配信予約中のため、ロックされています。
`KR_API_F0211`	`MailMessage Is Not For Delivery.`	指定されたメール文面はエージェント配信用の文面ではありません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

mail_message_id

required

integer

削除するエージェント配信用メール文面のID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/delete_mail_message_for_agent_program

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/delete_mail_message_for_agent_program

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/delete_mail_message_for_agent_program

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/delete_mail_message_for_agent_program

Request samples

Payload

Content type

application/json

{"mail_message_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

{"result": true
}

配信関連 API

メールや通知などの配信処理を行うAPI群です。

メール配信予約を追加

メール文面の配信予約を登録します。

必要オプション

メール

必要権限

全てのアクセス権または作業のみ

監査ログ

配信予約追加

備考

delete_conditionを有効（true）にした場合の、抽出条件が削除されるための条件は以下のとおりです。これらの条件を満たさない場合は、抽出条件は削除されません。
- ユーザ定義の条件であること。
- 他で（例: 別の配信）使用されていないこと。
抽出条件が削除された場合は、その監査ログが記録されます。

エラー

例外コード	例外説明	状況
`KR_API_F0102`	`MailMessage Is Locked.`	ロック中の文面IDを指定しました。
`KR_API_F0103`	`Element Type Is Not Email.`	メールアドレス項目が指定されていません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

mail_message_id

required

integer

文面ID

required

object (DeliveryInfoForAdd)

配信予約情報です。

title required	string 配信予約の名称です。
condition_id required	integer 抽出条件IDです。
element_id required	integer メールアドレスの項目IDです。
delivery_date required	integer 配信時間（UNIXタイムスタンプ）です。
blacklist	boolean Default: false ブラックリストを有効にするかどうかを指定します。
delete_condition	boolean Default: false 配信引き渡し完了後に抽出条件を自動削除するかどうかを指定します。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/add_delivery_schedule

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/add_delivery_schedule

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/add_delivery_schedule

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/add_delivery_schedule

Request samples

Payload

Content type

application/json

{"mail_message_id": 1,
"delivery_info": {"title": "2007年12月13分配信予約",
"condition_id": 1,
"element_id": 1,
"delivery_date": 19320910293,
"blacklist": false,
"delete_condition": false
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"delivery_id": 1
}

テスト配信予約を追加

メール文面のテスト配信予約を登録します。

テスト配信時にはSubjectの先頭にprefixで指定した文字列が追加されます。

必要オプション

メール

必要権限

全てのアクセス権または作業のみ

監査ログ

テスト配信設定

備考

配信アドレスに指定したアドレスが、該当のデータベースに登録されていない場合は配信対象外となります。
emailsに同一のアドレスが指定された場合は集約されます。
Subject の先頭に追加する文字列として、 prefix を追加したくない場合は空文字列を指定してください。
delivery_dateに過去の時間を指定した場合は、次の配信タイミングの時間に切り上げられます。

エラー

例外コード	例外説明	状況
`KR_API_F0102`	`MailMessage Is Locked.`	ロック中の文面IDを指定しました。
`KR_API_F0103`	`Element Type Is Not Email.`	メールアドレス項目が指定されていません。
`KR_API_F0214`	`No Destination Addresses.`	配信先アドレスが指定されていません。
`KR_API_F0215`	`Too Many Destination Addresses.`	配信先アドレスが上限（50）を超えています。
`KR_API_F0216`	`Invalid Destination Address.`	配信アドレスに不正な形式のものがあります。

Authorizations:

bearerAuth

Request Body schema: application/json
required

mail_message_id

required

integer

文面ID

required

object (DeliveryInfoForTestAdd)

テスト配信予約情報です。

emails required	Array of strings <email> <= 50 items [ items <email > ] 配信対象とするメールアドレスの一覧です。
prefix	string or null Default: "【テスト配信】" Subjectの先頭に追加する文字列です。
element_id required	integer メールアドレスの項目IDです。
delivery_date	integer or null 配信時間（UNIXタイムスタンプ）です。未指定の場合は次の配信タイミングの時刻が設定されます。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/add_test_delivery_schedule

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/add_test_delivery_schedule

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/add_test_delivery_schedule

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/add_test_delivery_schedule

Request samples

Payload

Content type

application/json

{"mail_message_id": 1,
"delivery_info": {"emails": ["add1@example.com",
"add2@example.com"
],
"prefix": "【テスト配信】",
"element_id": 1,
"delivery_date": 19320910293
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"delivery_id": 1
}

指定されたメール配信予約をキャンセル

指定された配信予約を取り消します。

ただし、取消可能な配信予約は通常配信およびテスト配信のみです。エージェント配信の配信予約は取消不可です。該当の配信予約が配信中の場合も削除不可とします。

必要オプション

メール

必要権限

全てのアクセス権または作業のみ

監査ログ

テスト配信設定（ドキュメントには "テスト配信設定" とありますが、"配信予約取消" の方が適切かもしれません。ドキュメントに従います。）

備考

配信が完了した配信IDを指定した場合は、配信リストからすでに削除されているので、KR_API_F0005 (Invalid Object ID) の例外になることに注意してください。

エラー

例外コード	例外説明	状況
`KR_API_F0212`	`Delivery Is For Agent Program.`	配信予約はエージェント配信のため、取消不可です。
`KR_API_F0213`	`Delivery Is Already Started.`	配信予約は配信中のため、取消不可です。

Authorizations:

bearerAuth

Request Body schema: application/json
required

delivery_id

required

integer

配信ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/cancel_delivery_schedule

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/cancel_delivery_schedule

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/cancel_delivery_schedule

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/cancel_delivery_schedule

Request samples

Payload

Content type

application/json

{"delivery_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

true

新しいエージェント配信を設定

指定した文面でエージェント配信設定を追加します。

必要オプション

メール

必要権限

全てのアクセス権または操作のみ

監査ログ

エージェント配信予約追加

備考

設定追加時、直近の配信時間が5分以内、または過去の日時となる場合、「次回配信日」として次の配信日が設定されます。

エラー

例外コード	例外説明	状況
`KR_API_F0102`	`MailMessage Is Locked.`	指定されたメール文面はエージェント配信予約中のため、ロックされています。
`KR_API_F0103`	`Element Type Is Not Email.`	メールアドレス項目が指定されていません。
`KR_API_F0131`	`Element Type Is Not Date.`	指定可能な日付項目が指定されていません。
`KR_API_F0225`	`MailMessage Is Not For Agent Delivery.`	指定された文面はエージェント配信用の文面ではありません。
`KR_API_F0227`	`Agent Program Reached Max.`	エージェント配信設定数が上限に達しています。

Authorizations:

bearerAuth

Request Body schema: application/json
required

mail_message_id

required

integer

エージェント配信で使用する文面ID

required

object (ProgramInfoForAdd)

エージェント配信設定情報です。

title

required

string

エージェント配信予約名称です。

condition_id

required

integer

抽出条件IDです。

element_id

required

integer

メールアドレス項目IDです。

blacklist

boolean

Default: false

Enum: true false

ブラックリストを有効にするかどうかを指定します。

true - 有効
false - 無効

enable

boolean

Default: false

Enum: true false

配信設定の稼動状態を指定します。

true - 稼働する
false - 停止する

required

object (DeliveryTimeInfo)

配信間隔の情報です。

type required	integer Enum: 1 2 3 配信間隔のタイプを指定します。 `1`: 毎日 `2`: 毎週 `3`: 毎月
hour required	integer [ 0 .. 23 ] 配信時刻（時）を指定します。
min required	integer Enum: 0 5 10 15 20 25 30 35 40 45 50 55 配信時刻（分）を指定します。
day_of_week	integer or null Enum: 0 1 2 3 4 5 6 配信曜日を指定します。`type`が2 (毎週) の場合に必須です。 `0`: 日曜日 `1`: 月曜日 `2`: 火曜日 `3`: 水曜日 `4`: 木曜日 `5`: 金曜日 `6`: 土曜日
	(配信日 (integer or null)) or (末日 (integer or null)) 配信日を1～31で指定します。99 を指定すると末日になります。 `type` が3 (毎月) の場合に必須です。
One of [ 1 .. 31 ] integer or null (配信日) [ 1 .. 31 ] 配信日を1～31で指定します。99 を指定すると末日になります。 `type` が3 (毎月) の場合に必須です。

object or null (DeliveryConditionInfo)

配信条件の情報です。delivery_time_infoのtypeが1 (毎日) の場合に必須です。

pattern required	integer Enum: 1 2 条件パターンを指定します。 `1`: パターン1 `2`: パターン2
element_id required	integer 基準とする項目IDを指定します。
offset	integer or null [ 0 .. 999 ] `direction`や`interval_days`とセットで用いる値を指定します。「`pattern`が1かつ`direction`が0以外」、または「`pattern`が2」の場合に必須です。
direction	integer or null Enum: 0 1 2 3 4 5 6 日付の方向を指定します。 `0`: 当日 `1`: ～日前 `2`: ～日後 `3`: ～週間前 `4`: ～週間後 `5`: ～ヶ月前 `6`: ～ヶ月後。`pattern`が1の場合に利用します。
enable_year	boolean or null 項目の「年」を有効にするかどうかを指定します。`pattern`が1の場合に利用します。
interval_days	integer or null [ 1 .. 999 ] 配信間隔（日毎）を指定します。`pattern`が2の場合に利用します。
max_num	integer or null >= 0 Default: 0 最大配信数を指定します。0の場合は制限なしです。 `pattern`が2の場合に利用します。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/add_agent_program

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/add_agent_program

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/add_agent_program

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/add_agent_program

Request samples

Payload

Content type

application/json

{"mail_message_id": 1,
"program_info": {"title": "毎月1日の10時に配信",
"condition_id": 1,
"element_id": 1,
"blacklist": false,
"enable": false,
"delivery_time_info": {"type": 1,
"hour": 5,
"min": 15,
"day_of_week": 0,
"day": 3
},
"delivery_condition_info": {"pattern": 1,
"element_id": 1,
"offset": 1,
"direction": 0,
"enable_year": true,
"interval_days": 1,
"max_num": 3
}
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"agent_program_id": 1
}

指定されたエージェント配信を削除

指定されたエージェント配信設定を削除します。稼働中の配信設定でも削除可能です。

必要オプション

メール

必要権限

全てのアクセス権または操作のみ

監査ログ

エージェント配信予約削除

Authorizations:

bearerAuth

Request Body schema: application/json
required

agent_program_id

required

integer

エージェント配信設定ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/delete_agent_program

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/delete_agent_program

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/delete_agent_program

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/delete_agent_program

Request samples

Payload

Content type

application/json

{"agent_program_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

true

エージェント配信を有効化または無効化する

指定されたエージェント配信設定の稼働状態を変更します。

必要オプション

メール

必要権限

全てのアクセス権または操作のみ

監査ログ

エージェント配信の稼働状態変更

備考

監査ログは稼働状態が変更されなくても記録されます。

Authorizations:

bearerAuth

Request Body schema: application/json
required

agent_program_id required	integer エージェント配信設定ID
enable required	boolean Default: true `true`: 稼働する `false`: 停止する

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/enable_agent_program

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/enable_agent_program

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/enable_agent_program

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/enable_agent_program

Request samples

Payload

Content type

application/json

{"agent_program_id": 1,
"enable": true
}

Response samples

200
4xx
5xx

Content type

application/json

true

エージェント配信の一覧を取得

指定されたデータベースに登録されているエージェント配信設定情報の一覧を取得します。

必要オプション

メール

必要権限

全てのアクセス権または参照のみまたは操作のみ

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

データベースID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_agent_programs

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_agent_programs

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_agent_programs

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_agent_programs

Request samples

Payload

Content type

application/json

{"member_table_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

{"agent_programs": [{"id": 1,
"title": "エージェント配信設定名称",
"condition_id": 1,
"mail_message_id": 1,
"element_id": 1,
"blacklist": false,
"enable": false,
"delivery_time_info": {"type": 1,
"hour": 5,
"min": 15,
"day_of_week": 0,
"day": 3
},
"delivery_condition_info": {"pattern": 1,
"element_id": 1,
"offset": 1,
"direction": 0,
"enable_year": true,
"interval_days": 1,
"max_num": 3
}
}
]
}

エージェント配信に関連するメール文面を取得

指定したエージェント配信で使用中の文面情報を取得します。

必要オプション

メール

必要権限

全てのアクセス権、操作のみ

Authorizations:

bearerAuth

Request Body schema: application/json
required

agent_program_id

required

integer

エージェント配信設定ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_mail_message_by_agent_program

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_mail_message_by_agent_program

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_mail_message_by_agent_program

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_mail_message_by_agent_program

Request samples

Payload

Content type

application/json

{"agent_program_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

{"mail_message_info": {"mail_message_id": 1,
"member_table_id": 1,
"type": 1,
"allow_hankana": false,
"from": "sales@tricorn.co.jp",
"from_desc": "TRICORNセールス",
"reply": "contact@tricorn.co.jp",
"reply_desc": "TRICORNお問い合わせ",
"subject": "件名",
"text_part": "テキストパート本文",
"html_part": "htmlパート本文",
"clickcounts": [{"url": "http://www.tricorn.co.jp/",
"days": 7,
"outdated_url": "http://www.tricorn.co.jp/"
}
],
"open_clickcount": false,
"oneclick_date": 168,
"oneclick_date_sec": 5400
}
}

メール配信状況のステータスを取得

指定された配信の配信状態を取得します。

必要オプション

メール

必要権限

全てのアクセス権、参照のみまたは操作のみ

Authorizations:

bearerAuth

Request Body schema: application/json
required

delivery_id

required

integer

配信ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_delivery_status

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_delivery_status

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_delivery_status

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_delivery_status

Request samples

Payload

Content type

application/json

{"delivery_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

{"phase": 0,
"desc": "配信対象数 302 （37%完了）"
}

配信履歴を取得

指定された配信の配信結果を取得します。

必要オプション

メール

必要権限

全てのアクセス権、参照のみまたは作業のみ

備考

実配信数 = All - Stopped - no_address - Blacklist - unsubscribed_address
有効配信数 = All - Stopped - no_address - Blacklist - unsubscribed_address - Error
配信エラーは配信完了後も更新され続けることに注意してください。
このAPIを再度発行するときは、30秒以上の間隔をあけなければなりません。

エラー

(API固有のSOAP例外はなし)

Authorizations:

bearerAuth

Request Body schema: application/json
required

delivery_id

required

integer

配信ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_delivery_result

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_delivery_result

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_delivery_result

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_delivery_result

Request samples

Payload

Content type

application/json

{"delivery_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

{"count_info": {"all": 3092,
"stopped": 63,
"no_address": 212,
"error": 678,
"blacklist": 23,
"unsubscribed_address": 10,
"ready": 423,
"composed": 1716
},
"start_date": 1184322300,
"end_date": 1187942430
}

配信対象のメールアドレス一覧を取得

指定された配信に含まれるアドレス情報を取得します。

1回のAPIコールについて、取得できるアドレス数は50,000までです。以降のアドレスを取得するときは、オフセットを変更して再度コールしてください。

必要オプション

メール

必要権限

全てのアクセス権または参照のみ

Authorizations:

bearerAuth

Request Body schema: application/json
required

delivery_id required	integer 配信ID
type required	string Enum: "stopped" "no_address" "blacklist" "unsubscribed_address" "error" "valid" 取得するアドレス情報の配信種別。 `stopped` - 配信停止 `no_address` - アドレス無し `blacklist` - ブラックリスト `unsubscribed_address` - 登録解除リスト `error` - エラー `valid` - 有効配信
offset required	integer >= 0 何番目のアドレス情報から取得するかのオフセット。最初のオフセットは0です。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_addresses_for_delivery

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_addresses_for_delivery

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_addresses_for_delivery

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_addresses_for_delivery

Request samples

Payload

Content type

application/json

{"delivery_id": 1,
"type": "valid",
"offset": 1000
}

Response samples

200
4xx
5xx

Content type

application/json

{"address_info": [{"member_id": 3092,
"address": "error@example.com",
"error_code": "5.1.1",
"error_desc": "アドレスが存在しない"
}
]
}

配信に含まれるクリックカウントURL一覧を取得

指定された配信IDに登録されているクリックカウントの一覧を取得します。

必要オプション

メール

必要権限

全てのアクセス権または参照のみ

Authorizations:

bearerAuth

Request Body schema: application/json
required

delivery_id

required

integer

配信ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_click_counts_for_delivery

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_click_counts_for_delivery

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_click_counts_for_delivery

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_click_counts_for_delivery

Request samples

Payload

Content type

application/json

{"delivery_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

{"clickcount_info": [{"id": 1,
"url": "http://www.tricorn.co.jp/",
"outdated_url": "http://www.tricorn.co.jp/",
"collect_date": "2009-01-31 17:00:00",
"type": 0,
"total_num": 392,
"unique_num": 232,
"raito": 5.8,
"result": true
}
]
}

クリックカウント結果を取得

clickcount_idに指定されたクリックカウントの記録を取得します。

1回のAPIコールについて、取得できる記録は10000までです。以降の記録を取得するときは、オフセットを変更して再度コールしてください。

クリックカウントの記録の保存期間が過ぎたときは、空の配列となります。

必要オプション

メール

必要権限

全てのアクセス権または参照のみ

エラー

例外コード	例外説明	状況
`KR_API_F0304`	`Invalid Offset.`	オフセット値が正しくありません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

clickcount_id required	integer クリックカウントID
offset required	integer >= 0 何番目のクリックカウント記録から取得するかのオフセット。最初のオフセットは0です。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_click_count_result

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_click_count_result

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_click_count_result

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_click_count_result

Request samples

Payload

Content type

application/json

{"clickcount_id": 1,
"offset": 1000
}

Response samples

200
4xx
5xx

Content type

application/json

{"clickcount_log_info": [{"clicked_date": "2009-01-15 00:00:00",
"member_id": 20,
"address": "test@example.com",
"ip_address": "192.168.0.1",
"user_agent": ""
}
]
}

一定期間内の配信履歴を取得

指定されたデータベース、指定された期間の配信履歴（テスト配信含む）を取得します。（エージェント配信は含まれません）該当する配信が無い場合は空の配列が戻ります。 1回のAPIコールについて、取得できる配信履歴は直近100までです。それ以降の記録を取得するときは、期間を変更して再度コールしてください。

必要オプション

メール

必要権限

全てのアクセス権、参照のみ操作のみ

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id required	integer データベースID
start_timestamp	integer or null 検索の範囲となる開始日時（UNIXタイムスタンプ）。未指定の場合は`null`を指定します。
end_timestamp	integer or null 検索の範囲となる終了日時（UNIXタイムスタンプ）。未指定の場合は`null`を指定します。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_delivery_results_by_interval

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_delivery_results_by_interval

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_delivery_results_by_interval

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_delivery_results_by_interval

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"start_timestamp": 1314342825,
"end_timestamp": 1314372825
}

Response samples

200
4xx
5xx

Content type

application/json

{"delivery_infos": {"property1": {"title": "配信予約",
"subject": "文面サブジェクト",
"condition_title": "（全員）",
"mail_type": 1,
"delivery_date": 1,
"status": "sent",
"nums": 132
},
"property2": {"title": "配信予約",
"subject": "文面サブジェクト",
"condition_title": "（全員）",
"mail_type": 1,
"delivery_date": 1,
"status": "sent",
"nums": 132
}
}
}

エージェント配信ごとの配信結果を取得

指定されたエージェント配信、指定された期間の配信履歴を取得します。該当する配信が無い場合は空の配列が戻ります。 1回のAPIコールについて、取得できる配信履歴は直近100までです。それ以降の記録を取得するときは、期間を変更して再度コールしてください。

必要オプション

メール

必要権限

全てのアクセス権、参照のみ操作のみ

Authorizations:

bearerAuth

Request Body schema: application/json
required

agent_program_id required	integer エージェント配信ID
start_timestamp	integer or null 検索の範囲となる開始日時（UNIXタイムスタンプ）。未指定の場合は`null`を指定します。
end_timestamp	integer or null 検索の範囲となる終了日時 (Unix timestamp)。未指定の場合は`null`を指定します。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_delivery_results_by_agent_program

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_delivery_results_by_agent_program

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_delivery_results_by_agent_program

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_delivery_results_by_agent_program

Request samples

Payload

Content type

application/json

{"agent_program_id": 1,
"start_timestamp": 1314342825,
"end_timestamp": 1314372825
}

Response samples

200
4xx
5xx

Content type

application/json

{"delivery_infos": {"property1": {"title": "配信予約",
"subject": "文面サブジェクト",
"condition_title": "（全員）",
"mail_type": 1,
"delivery_date": 1,
"status": "sent",
"nums": 132
},
"property2": {"title": "配信予約",
"subject": "文面サブジェクト",
"condition_title": "（全員）",
"mail_type": 1,
"delivery_date": 1,
"status": "sent",
"nums": 132
}
}
}

指定した配信情報の概要を取得

指定された配信結果のサマリ情報を一括取得します。

必要オプション

メール

必要権限

全てのアクセス権、参照のみ操作のみ

Authorizations:

bearerAuth

Request Body schema: application/json
required

delivery_id

required

integer

配信ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_summary_for_delivery_status

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_summary_for_delivery_status

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_summary_for_delivery_status

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_summary_for_delivery_status

Request samples

Payload

Content type

application/json

{"delivery_id": 1
}

Response samples

200
4xx
5xx

Content type

application/json

{"delivery_infos": {"messages": {"type": "テキストメール",
"allow_hankana": "使用しない",
"from": "info@tricorn.co.jp",
"from_desc": "Fromメールアドレス",
"reply": "info@tricorn.ne.jp",
"reply_desc": "Replyメールアドレス",
"subject": "文面サブジェクト",
"text_part": "string",
"html_part": "string",
"enabled_smime": "使用する",
"list_unsubscribe": "なし"
},
"statuses": {"title": "配信予約名",
"condition_title": "（全員）",
"delivery_date": {"start": "2012/08/24 10:00:00",
"end": "2012/08/24 10:05:39"
},
"status": "文面引き渡し完了",
"enabled_blacklist": "有効",
"phase": "配信対象数:30 (81%完了)",
"oneclick_login_limit": "2012/08/31 10:00:00"
},
"results": {"all": [3092,
"100.0%"
],
"stopped": [3092,
"100.0%"
],
"no_address": [3092,
"100.0%"
],
"blacklist": [3092,
"100.0%"
],
"real": [3092,
"100.0%"
],
"error": [3092,
"100.0%"
],
"valid": [3092,
"100.0%"
],
"ready": [3092,
"100.0%"
],
"compose": [3092,
"100.0%"
],
"unsubscribed_address": [3092,
"100.0%"
]
},
"errors": {"5.1.1": ["アドレスが存在しない",
31,
"4.0%"
],
"5.1.2": ["ドメイン名が存在しない",
18,
"2.3%"
]
},
"click_counts": {"total_num": 1854,
"unique_num": 178,
"ratio": "8.4%",
"details": [{"id": 1,
"type": 0,
"url": "http://www.tricorn.co.jp/",
"collect_date": "2009/01/31 17:00:00",
"total_num": 392,
"unique_num": 232,
"ratio": "5.8%"
}
]
}
}
}

misc API

上記のカテゴリに分類されないその他のAPI群です。

KREISELのバージョンを取得

KREISELのバージョン番号を取得します。

必要権限

なし

Request Body schema: application/json

このAPIはリクエストボディを必要としません。

object or null

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_version

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_version

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_version

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_version

Request samples

Payload
CLI

Content type

application/json

{ }

Response samples

200
4xx
5xx

Content type

application/json

{"version": "1.5.0"
}

郵便番号から住所を検索

郵便番号から該当する住所を取得します。複数該当する場合はその一覧を返します。

存在しない場合は空の配列を返します。

必要権限

なし

備考

郵便番号辞書は日本郵政のサイトから取得できる「住所の郵便番号」と「事業所の個別郵便番号」に対応します。
日本郵政のサイトの郵便番号辞書の更新が反映されるまで、最大1週間の期間を要することに注意してください。
「住所の郵便番号」で町域名に「以下に掲載がない場合」が記載されている場合は、住所2、住所2のよみは空欄に変換されます。
「事業所の個別郵便番号」に登録されている住所には、住所1のよみ、住所2のよみは空欄となります。

エラー

エラーコード	エラー説明	状況
`KR_API_F0207`	Invalid Zip Format.	郵便番号の形式が正しくありません。
`KR_API_F0208`	Zip Address Database Not Ready.	郵便番号データベースの準備ができていません（しばらく時間を置いたのち、再試行してください）。

Authorizations:

bearerAuth

Request Body schema: application/json
required

required	7桁ハイフンなし (string) or 3桁-4桁 (string) 郵便番号 (7桁ハイフンなしか、3桁-4桁のどちらか)
One of string (7桁ハイフンなし) ^\d{7}$ 郵便番号 (7桁ハイフンなしか、3桁-4桁のどちらか)

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/search_addresses_by_zip

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/search_addresses_by_zip

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/search_addresses_by_zip

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/search_addresses_by_zip

Request samples

Payload

Content type

application/json

{"zip": "123-4567"
}

Response samples

200
4xx
5xx

Content type

application/json

{"addresses": [{"pref_code": 0,
"pref": "string",
"addr1": "string",
"addr2": "string",
"addr1_yomi": "string",
"addr2_yomi": "string"
}
]
}

フォーム関連 API

ユーザー入力フォームの作成やデータ処理を行うAPI群です。

フォームの一覧を取得

指定したデータベースに登録されているフォームの情報一覧を取得します。

必要オプション

フォーム

必要権限

全ての権限
参照のみ
操作のみ

備考

count_records は、特定のフォームで登録、または削除された会員数の増減を保存します。
max_records と count_records が共に未定義の場合は、最大数の制限はありません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

データベースID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_member_forms

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_member_forms

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_member_forms

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_member_forms

Request samples

Payload

Content type

application/json

{"member_table_id": 3
}

Response samples

200
4xx
5xx

Content type

application/json

{"form_infos": [{"id": 0,
"form_type": "auto",
"type": "regist",
"title": "フォーム",
"carriers": "docomo au",
"start_date": 0,
"end_date": 0,
"alias": "string",
"enable": true,
"double_optin": true,
"override": true,
"max_record_type": 0,
"max_records": 0,
"count_records": 0
}
]
}

フォーム項目一覧を取得

指定したフォームに登録されているフォーム項目の情報一覧を取得します。

必要オプション

フォーム

必要権限

全ての権限
参照のみ
操作のみ

Authorizations:

bearerAuth

Request Body schema: application/json
required

form_id

required

integer

フォームID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_member_form_elements

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_member_form_elements

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_member_form_elements

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_member_form_elements

Request samples

Payload

Content type

application/json

{"form_id": 331
}

Response samples

200
4xx
5xx

Content type

application/json

{"element_infos": [{"id": 0,
"element_id": 0,
"type": "text",
"title": "名前",
"requirement": 1
}
]
}

フォーム項目に入力された値のバリデーションチェックを行う

指定されたフォーム項目について、入力された値の形式チェックを行います。

エラーがない場合は空の配列を返します。

必要オプション

フォーム

必要権限

なし

備考

複数の項目について形式チェックを行う場合は、項目ごとにこのAPIを発行するか、validate_member_form_parameters を使用してください。
機種依存文字が許可されているテキスト、テキストエリア項目は機種依存文字を送信可能です。
全角カナが許可されているテキスト、テキストエリア項目について、半角カナ→全角カナ変換設定が有効な場合は、半角カナを送信可能です（半角カナを全角カナに変換した上で処理）。

エラー

エラーコード	エラー説明	状況
`KR_API_F0110`	Not API Form.	APIフォームではありません。
`KR_API_F0121`	Invalid Form Element Name.	指定されたフォーム項目の名称は存在しません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

form_id

required

integer

フォームID

form_element_name

required

string

フォーム項目の名称 (name 属性値)

required

object

フォームから入力された値。値の型は項目タイプに依存します。

詳細は「フォーム項目のパラメータ化の方法」を参照してください。

do_member_form_action で送信する会員情報（の一部）と同じ形式のデータを渡してください。

additional property	string or integer or boolean or Array of integers
One of string

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/validate_member_form_parameter

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/validate_member_form_parameter

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/validate_member_form_parameter

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/validate_member_form_parameter

Request samples

Payload

Content type

application/json

{"form_id": 3,
"form_element_name": "e_4",
"parameter": "test@example.com"
}

Response samples

200
4xx
5xx

Content type

application/json

{"errors": ["エラー: パラメータの型が正しくありません。"
]
}

フォーム項目のバリデーションを一括でチェックする

指定された各フォーム項目について、入力値の形式チェックを一括で行います。

エラーがない項目のエラーメッセージ配列は空になります。

必要オプション

フォーム

必要権限

なし

備考

機種依存文字が許可されているテキスト、テキストエリア項目は機種依存文字を送信可能です。
全角カナが許可されているテキスト、テキストエリア項目について、半角カナ→全角カナ変換設定が有効な場合は、半角カナを送信可能です（半角カナを全角カナに変換した上で処理）。
validate_member_form_parameter で行う形式チェックと同じチェックが行われます。

エラー

エラーコード	エラー説明	状況
`KR_API_F0110`	Not API Form.	APIフォームではありません。
`KR_API_F0121`	Invalid Form Element Name.	指定されたフォーム項目の名称のうち、存在しないものがあります。

Authorizations:

bearerAuth

Request Body schema: application/json
required

form_id

required

integer

フォームID

required

object

形式チェックを行う項目名称とその値のペア。キーはフォーム項目名 (例: e_1)、値は入力値です。

値の型は項目タイプに依存します。

詳細は「フォーム項目のパラメータ化の方法」を参照してください。

additional property	string or integer or boolean or Array of integers
One of string

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/validate_member_form_parameters

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/validate_member_form_parameters

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/validate_member_form_parameters

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/validate_member_form_parameters

Request samples

Payload

Content type

application/json

{"form_id": 3,
"form_element_values": {"e_1": 2,
"e_2": "xxx@tricorn.co.jp"
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"errors": {"e_1": [ ],
"e_2": ["エラー: 形式が正しくありません。"
]
}
}

会員情報が重複エラーとなるか判定

フォームに入力されたキー項目が、既存の登録情報と重複しているか確認します。

重複キーの設定がない場合、または自動採番項目が重複キーに設定されている場合は無条件に true を返します。

必要オプション

フォーム

必要権限

なし

備考

このAPIは登録フォーム・更新フォームのみで使用可能です。それ以外のフォームの場合はエラーとなります。
このAPIで判断できるのは、その時点における結果であることに注意してください。別の公開フォームからの登録によって、do_member_form_action の時点では重複エラーが発生することがあります。
機種依存文字が許可されているテキスト項目は機種依存文字を送信可能です。
全角カナが許可されているテキスト項目について、半角カナ→全角カナ変換設定が有効な場合は、半角カナを送信可能です（半角カナを全角カナに変換した上で処理）。

エラー

エラーコード	エラー説明	状況
`KR_API_F0110`	Not API Form.	APIフォームではありません。
`KR_API_F0123`	Form Is Not For Either Regist or Update.	フォームは登録フォームでも更新フォームでもありません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

form_id

required

integer

フォームID

member_id

required

integer

会員ID。更新フォームの場合に指定します。登録フォームの場合は 0 を指定してください。

required

object (MemberInfoFormParameter)

フォーム項目にセットする会員情報。

キーはフォーム項目名（例: e_1, new_pass）、値は各項目の値です。

値の型は「フォーム項目のパラメータ化の方法」を参照してください。

additional property	(string or null) or (integer or null) or (boolean or null) or (Array of integers or null)
One of string or null

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/check_unique_member_confliction

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/check_unique_member_confliction

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/check_unique_member_confliction

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/check_unique_member_confliction

Request samples

Payload

Content type

application/json

{"form_id": 31,
"member_id": 0,
"member_info": {"e_1": 2,
"e_2": "xxx@tricorn.co.jp",
"new_pass": "new_password_value"
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"is_unique": true
}

指定したフォームと同等のアクションを行う

JSON APIフォームを通じて処理（会員登録・更新・削除・パスワード変更・パスワード再発行）を行います。

通常のフォームをブラウザ経由で送信した場合の処理をエミュレートし、自動返信メール・アクション通知・Webhook通知なども指定された通りに動作します。

必要オプション

フォーム

必要権限

なし

備考

機種依存文字が許可されているテキスト、テキストエリア項目は機種依存文字を送信可能です。
全角カナが許可されているテキスト、テキストエリア項目について、半角カナ→全角カナ変換設定が有効な場合は、半角カナを送信可能です（半角カナを全角カナに変換した上で処理）。
「テキスト（暗号化）」項目が存在するデータベースにおいて、暗号項目鍵の利用権限を持たないログインユーザが会員登録・更新を行った場合は登録・更新不可となります。
表示タイプが任意の「テキスト（暗号化）」項目に対して空文字を指定、もしくは項目を指定しなかった場合は、空文字を暗号化したデータで登録・更新されます。
自動採番項目は指定した設定に従い自動生成されるため、送信は不要であり、送信してもその値は無視されます。

エラー

エラーコード	エラー説明	状況
`KR_API_F0110`	Not API Form.	APIフォームではありません。
`KR_API_F0111`	FormGorup Is Not Enabled.	フォームグループが公開状態になっていません。
`KR_API_F0112`	Form Is Not Enabled.	フォームが有効になっていません。
`KR_API_F0113`	Form Is Before.	フォームが公開期間の前になっています。
`KR_API_F0114`	Form Is After.	フォームが公開期間の後になっています。
`KR_API_F0115`	Form Member Reached Max.	登録数がオーバーしています。（登録フォームのみ）
`KR_API_F0116`	Action Is Not Finished.	フォーム処理が完了しませんでした（各項目設定による制約エラーも含む）。
`KR_API_F0117`	Member Already Exists.	重複エラーが発生しました（登録・更新フォームのみ）。
`KR_API_F0118`	Member Is Not Exists.	指定された会員が存在しません（更新・削除・パスワード変更・パスワード再発行のみ）。
`KR_API_F0228`	Exist Not Authorized Encryption Element.	「テキスト（暗号化）」項目が存在するDBで、暗号項目鍵の利用権限がないユーザが登録・更新を行いました。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_form_id

required

integer

フォームID

member_id

required

integer

操作の対象となる会員ID。ただし、登録の場合は 0 を指定してください。

required

object (MemberInfoFormParameter)

フォーム項目にセットする情報。

登録・更新・パスワード変更の場合のみ指定します。

削除、パスワード再発行の場合は空のオブジェクト {} を指定してください。

additional property	(string or null) or (integer or null) or (boolean or null) or (Array of integers or null)
One of string or null

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/do_member_form_action

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/do_member_form_action

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/do_member_form_action

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/do_member_form_action

Request samples

Payload

Content type

application/json

{"member_form_id": 1,
"member_id": 0,
"member_info": {"e_1": 2,
"e_2": "xxx@tricorn.co.jp",
"new_pass": "new_password_value"
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"member_id": 3092
}

フォームの認証と同等の処理を行う

JSON APIフォームを通じて、会員の認証（ログイン）を行います。

指定された情報に基づいて該当する会員を抽出し、パスワードの一致を確認します。

パスワードが一致した場合はその会員の会員IDを返します。

必要オプション

フォーム

必要権限

なし

備考

パスワード再発行フォームに対してこのAPIを発行する場合、認証用パスワードは必須ではありません。
フォームの認証用パスワードの設定によっては、フォームごとに認証の可否が変わることに注意してください。
指定された会員情報の妥当性検証に失敗した場合は、0 ではなく共通エラー KR_API_F0004 (Invalid Parameter) を返却します。
- R1.22より仕様変更。
認証用項目がパスワード（ハッシュ）項目の場合、会員情報と認証用パスワードが一致していても、認証用パスワードが妥当性検証に失敗した場合は、0 を返します。
機種依存文字が許可されているテキスト項目は機種依存文字を送信可能です。

エラー

エラーコード	エラー説明	状況
`KR_API_F0110`	Not API Form.	APIフォームではありません。
`KR_API_F0111`	FormGorup Is Not Enabled.	フォームグループが公開状態になっていません。
`KR_API_F0112`	Form Is Not Enabled.	フォームが有効になっていません。
`KR_API_F0113`	Form Is Before.	フォームが公開期間の前になっています。
`KR_API_F0114`	Form Is After.	フォームが公開期間の後になっています。
`KR_API_F0119`	Form Is For Regist.	指定されたフォームは登録フォームのため認証できません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_form_id

required

integer

フォームID

required

object (MemberInfoFormParameter)

フォーム項目にセットする情報。重複キー項目のみ指定してください。

additional property	(string or null) or (integer or null) or (boolean or null) or (Array of integers or null)
One of string or null

password

required

string

認証用パスワード

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/auth_member

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/auth_member

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/auth_member

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/auth_member

Request samples

Payload

Content type

application/json

{"member_form_id": 1,
"member_info": {"e_1": 2,
"e_2": "xxx@tricorn.co.jp",
"new_pass": "new_password_value"
},
"password": "password"
}

Response samples

200
4xx
5xx

Content type

application/json

{"member_id": 3092
}

フォームで更新可能な会員情報を取得

更新フォームで更新前の会員情報を表示する場合の会員情報を取得します。

必要オプション

フォーム

必要権限

なし

備考

「テキスト（暗号化）」項目については、ログインユーザに対する暗号項目鍵の利用権限によって取得できる値が異なります。
- 権限あり: 暗号項目鍵によって復号された値（会員の実データ）
- 権限なし: 「（暗号化されています）」の文字列
「パスワード（ハッシュ）」項目については、取得される値は必ず「******」となります。

エラー

エラーコード	エラー説明	状況
`KR_API_F0120`	Form Is Not For Update.	指定されたフォームは更新フォームではありません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_form_id required	integer フォームID (更新フォームのみ)
member_id required	integer 会員ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_member_info_for_update

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_member_info_for_update

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_member_info_for_update

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_member_info_for_update

Request samples

Payload

Content type

application/json

{"member_form_id": 3,
"member_id": 5
}

Response samples

200
4xx
5xx

Content type

application/json

{"member_info": {"id": 132,
"regist_date": "2007-10-11 22:33:45",
"update_date": "2007-11-07 11:48:09",
"batch_date": null,
"e_4": "address@example.com",
"e_5": "k2(2#9d",
"e_6": 0,
"e_7": [1,
6
],
"e_8": false
}
}

削除フォームにて削除された会員情報一覧を取得

指定された削除フォームの削除ログから、指定日時以降の削除ログを最大100件取得します。 100件以上の削除会員情報を取得する場合は、offset を100ずつずらして、繰り返しAPIを呼び出してください。

必要オプション

フォーム

必要権限

全てのアクセス権
参照のみ

備考

削除会員情報は項目ごとの配列であり、さらにそれぞれは [項目名, 値] からなる配列です。
- 会員ID、削除日時の項目名はそれぞれ"ID"、"削除日時"です。
単一選択、複数選択、選択の場合、値は選択肢の名称になっていることに注意してください（複数選択の場合は、さらに各選択肢を空白でつなげたものです）。

エラー

例外コード	例外説明	状況
`KR_API_F0217`	Form Is Not For Delete.	削除フォームではありません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_form_id required	integer フォームID (削除フォームのみ)
after required	integer いつ以降に削除された削除会員情報を取得するかの日時 (UNIXタイムスタンプ)。フィルタをかけない場合は `0` を指定します。
offset required	integer 何番目の削除会員情報から取得するかのオフセット。最初の削除会員情報をオフセット `0` とします。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_deleted_member_list

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_deleted_member_list

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_deleted_member_list

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_deleted_member_list

Request samples

Payload

Content type

application/json

{"member_form_id": 3,
"after": 0,
"offset": 0
}

Response samples

200
4xx
5xx

Content type

application/json

{"deleted_members": [[["ID",
"66"
],
["メールアドレス",
"toda@tricorn.co.jp"
],
["削除日時",
"2009-08-20 13:45:23"
]
],
[["ID",
"67"
],
["メールアドレス",
"toda2@tricorn.co.jp"
],
["削除日時",
"2009-08-21 13:45:23"
]
]
]
}

フォームへのワンクリックログインURLを取得

指定されたフォームの指定した会員におけるワンクリックログインURLを取得します。

必要オプション

フォーム

必要権限

全てのアクセス権
参照のみ
操作のみ

備考

実際の有効期限は、API発行時の日時に limit（有効期間）を加えて時間未満を切り上げたものとなります。
指定したフォームが有効か無効かのチェックは行いません。
会員の存在しているかどうかのチェックは行いません。

エラー

エラーコード	エラー説明	状況
`KR_API_F0209`	Limit Is Out Of Range.	有効期限が正しい範囲にありません。
`KR_API_F0210`	Form Is No For Update or Delete.	更新・削除フォームではありません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_form_id required	integer フォームID (更新・削除フォームのみ)
member_id required	integer 会員ID
limit required	integer [ 1 .. 335 ] ワンクリックログインの有効期間。 `unit` 引数が `minute` の場合は分単位で指定してください。それ以外は時間単位で指定してください。 `unit` 引数が `minute` の場合: `90` （1時間30分） `unit` 引数が `hour` の場合: `168` （7日間）
unit	string Default: "hour" Enum: "minute" "hour" `limit` 引数で指定したワンクリックログインの有効期限の時間単位。分の場合は `minute` を指定してください。それ以外は時間単位として扱います。 `minute` - 分単位 `hour` - 時間単位

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_oneclick_login_url

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_oneclick_login_url

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_oneclick_login_url

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_oneclick_login_url

Request samples

Payload

Content type

application/json

{"member_form_id": 3,
"member_id": 1,
"limit": 168,
"unit": "minute"
}

Response samples

200
4xx
5xx

Content type

application/json

{"url": "https://krs.bz/your_env_id/form_alias/?key=value"
}

一括処理関連 API

大量のデータを一括で処理するためのAPI群です。

会員データをダウンロード

KREISELデータベースから会員データをエクスポート（ダウンロード準備）します。

Webの管理者画面の「ダウンロード」からダウンロード処理の指示を開始したのと同じです。このAPIの進行状況は get_batch_job_status により取得します。作成されたエクスポートファイルをダウンロードするためのURLは、JSON APIでは直接提供されず、代わりに get_batch_job_result APIを使用してファイル自体を取得します。

必要権限

全てのアクセス権または参照のみ

監査ログ

ダウンロード

備考

このAPIおよび import_members は同時に実行できません（他のデータベースであっても）。
「テキスト（暗号化）」項目については、ログインユーザに対する暗号項目鍵の利用権限によって取得できる値が異なります。
- 権限あり: 暗号項目鍵によって復号された値（会員の実データ）
- 権限なし: 「（暗号化されています）」の文字列

エラー

エラーコード	エラー説明	状況
`KR_API_F0205`	Other Operation Is Running.	他のエクスポート処理またはインポート処理が実行されています。
`KR_API_F0218`	Column Set Is Not For Download.	指定した項目セットが、検索・ダウンロード用ではありません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id required	integer データベースID
condition_id required	integer 抽出条件ID
columnset_id required	integer 項目セットID
is_csv	boolean Default: true エクスポートされたファイルの形式をCSVとするか (`true`: CSV, `false`: TSV)

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/export_members

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/export_members

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/export_members

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/export_members

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"condition_id": 2,
"columnset_id": 2,
"is_csv": true
}

Response samples

200
4xx
5xx

Content type

application/json

{"batch_job_id": 10
}

会員データを会員データベースへアップロード

KREISELデータベースへ会員データをインポートします。

このAPIの進行状況は get_batch_job_status により取得します。

アップロードログをダウンロードするには get_batch_job_result APIを使用します。

必要権限

全てのアクセス権または操作のみ

監査ログ

アップロード

備考

このAPIおよび export_members は同時に実行できません（他のデータベースであっても）。
機種依存文字が許可されているテキスト、テキストエリア項目は機種依存文字を送信可能です。
「テキスト（暗号化）」項目が存在するデータベースにおいて、暗号項目鍵の利用権限を持たないログインユーザがインポートを行った場合はインポート不可となります。
必須ではない「テキスト（暗号化）」項目に対して、特定の場合は空文字を暗号化したデータでインポートされます。
アップロードデータの中で空文字しか存在しない行については、エラー扱いされて会員DBに追加されません。
インポートされる項目の順番は該当データベース項目IDの表示順序に依存し、この順番はAPIから取得できません。

エラー

エラーコード	エラー説明	状況
`KR_API_F0203`	Invalid Override Option Key.	無効な更新オプション項目名が指定されました。
`KR_API_F0204`	Invalid Override Option Value.	無効な更新オプション値が指定されました。
`KR_API_F0205`	Other Operation Is Running.	他のインポート処理が実行されています。
`KR_API_F0206`	Aleady Imported File ID.	対象ファイルのインポートは完了しています。
`KR_API_F0219`	Invalid Extension.	無効なファイル拡張子が指定されました。
`KR_API_F0228`	Exist Not Authorized Encryption Element.	「テキスト（暗号化）」項目が存在するデータベースにおいて、暗号項目鍵の利用権限を持たないログインユーザがインポートを行いました。
`KR_API_F0231`	Key Element doesn't existed.	キー項目を指定せず、任意のキーで更新しようとしました。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

データベースID

stored_file_id

required

integer

転送ファイルデータの内部格納ID。 upload_stored_files APIなどで事前にアップロードしたファイルのIDを指定します。

integer or boolean

Default: false

転送ファイルデータの更新フラグ。

release 1.12 より仕様変更。整数型を推奨しますが、後方互換のため論理型も受け付けます。

キー項目を持たないデータベースでは、 false、0、3 以外の値を指定することはできません。

false または 0: 登録のみ
true または 1: 登録更新
2: 更新のみ
3: 任意のキーで更新

One of

integer

Default: false

Enum: 0 1 2 3

転送ファイルデータの更新フラグ。

release 1.12 より仕様変更。整数型を推奨しますが、後方互換のため論理型も受け付けます。

キー項目を持たないデータベースでは、 false、0、3 以外の値を指定することはできません。

false または 0: 登録のみ
true または 1: 登録更新
2: 更新のみ
3: 任意のキーで更新

object or null

項目毎の更新方法を指定します。キーは項目名 (例: e_156)、値は更新オプション文字列です。

override_optionsに指定しなかった項目は、is_update の値に応じたデフォルト値が採用されます。

指定しなかった項目には、各項目の設定に応じたデフォルト値が適用されます。

値ごとの動作

override_optionsで指定する値と、登録・更新時の基本的な動作は以下の通りです。

値	登録時の動作	更新時の動作
key	キー項目として扱います。	キー項目として扱います。
none	登録しません。	更新しません。
normal	インポートファイルの値で登録します。	インポートファイルの値で更新します（値が未入力の場合は更新しません）。
force	インポートファイルの値で登録します。	インポートファイルの値で更新します。
merge	インポートファイルの値で登録します。	既存の値にインポートファイルの値を追加します。（複数選択項目のみ）
auto	自動的に値を生成します。（パスワード項目のみ）	更新しません。
autogen	自動的に採番します。（自動採番項目のみ）	更新しません。

項目タイプごとの指定可能な値とデフォルト値

is_update の値と、各項目の設定（キー項目か否かなど）によって、指定可能な override_options の値とデフォルト値が異なります。

テキスト, メールアドレス, URL, 郵便番号, 電話番号

キー項目として設定されている場合

is_update の値説明指定可能な値デフォルト値

0, 1, 2 登録のみ, 登録更新, 更新のみ key key

3 任意のキーで更新 none, key none

キー項目として設定されていない場合

`is_update` の値	説明	指定可能な値	デフォルト値
`0`, `1`, `2`	登録のみ, 登録更新, 更新のみ	`none`, `normal`, `force`	`none`
`3`	任意のキーで更新	`none`, `key`, `normal`, `force`	`none`

テキストエリア, 整数, 単一選択, 日付, 都道府県, 性別, 未既婚, はい/いいえ, 選択, テキスト（暗号化）

`is_update` の値	説明	指定可能な値	デフォルト値
`0`, `1`, `2`, `3`	全てのモード	`none`, `normal`, `force`	`none`

パスワード（平文）, パスワード（ハッシュ）

`is_update` の値	説明	指定可能な値	デフォルト値
`0`	登録のみ	`auto`, `force`	`auto`
`1`, `2`, `3`	登録更新, 更新のみ, 任意のキーで更新	`auto`, `normal`	`auto`

複数選択

`is_update` の値	説明	指定可能な値	デフォルト値
`0`	登録のみ	`none`, `normal`, `force`	`none`
`1`, `2`, `3`	登録更新, 更新のみ, 任意のキーで更新	`none`, `normal`, `force`, `merge`	`none`

自動採番

キー項目として設定されている場合

is_update の値説明指定可能な値デフォルト値

0 登録のみ autogen autogen

1, 2 登録更新, 更新のみ key key

3 任意のキーで更新 autogen, key autogen
キー項目として設定されていない場合

is_update の値説明指定可能な値デフォルト値

0, 1, 2, 3 全てのモード autogen autogen

property name*

additional property

string

Enum: "key" "none" "normal" "force" "auto" "merge" "autogen"

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/import_members

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/import_members

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/import_members

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/import_members

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"stored_file_id": 185,
"is_update": false,
"override_options": {"e_156": "key",
"e_157": "force"
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"batch_job_id": 10
}

一括処理の進捗ステータスを取得

export_members や import_members などの一括処理のステータス状況を取得します。

必要権限

なし

備考

このAPIを再度発行するときは、30秒以上の間隔をあけなければなりません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

batch_job_id

required

integer

一括処理ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_batch_job_status

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_batch_job_status

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_batch_job_status

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_batch_job_status

Request samples

Payload

Content type

application/json

{"batch_job_id": 10
}

Response samples

200
4xx
5xx

Content type

application/json

{"start_date": 0,
"upload_date": 0,
"progress": 0,
"operation": "string"
}

会員データを一括削除

アップロード日時や項目ごとの条件を指定して会員の一括削除を行います。

必要権限

全てのアクセス権または操作のみ

監査ログ

一括削除

備考

additional_condition に条件を指定しない場合は、全ての会員情報が削除されるので注意してください。
「テキスト（暗号化）」項目が存在するデータベースにおいて、暗号項目鍵の利用権限を持たないログインユーザが会員の一括削除を行った場合でも削除可能です。

エラー

エラーコード	エラー説明	状況
`KR_API_F0229`	Condition Is Containing Encryption Element.	`additional_condition` に「テキスト（暗号化）」項目を含めました。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

データベースID

password

required

string

パスワード

grouping

boolean or null

項目間の条件の結合方法

true: AND
false: OR

object or null (ConditionParameter)

抽出条件の情報。

ConditionParameter スキーマのうち、主に conditions 部分を使用します。

詳細は「抽出条件のパラメータ化」を参照してください。

title

required

string

抽出条件の名称

grouping

required

boolean

Enum: true false

項目間の条件の結合方法

true: AND検索
false: OR検索

required

object

項目ごとの条件。キーは項目名（id, regist_date, e_## など）、値は IndividualCondition スキーマで定義される配列です。

additional property

Array of items (個別条件) = 2 items

項目ごとの条件を指定します。

キーは項目名（id, regist_date, e_## など）です。

値は [条件のとりかた (integer), 付加情報 (object)] の形式の配列です。

「付加情報」の構造は項目種別と「条件のとりかた」により異なります。詳しくは「抽出条件のパラメータ化」を参照してください。

[0]

integer

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 19 20 26 29

条件のとりかた。

1: 条件を指定しない
2: 条件値が対象値と完全に一致する
3: 条件値が対象値の前方（先頭基準）に含まれる
4: 条件値が対象値の後方（末尾基準）に含まれる
5: 条件値が対象値に含まれる
6: 条件値が対象値と完全に異なる
7: 条件値が対象値の前方（先頭基準）に含まれない
8: 条件値が対象値の後方（末尾基準）に含まれない
9: 条件値が対象値に含まれない
10: 対象値に何も記述されていない
11: 対象値が真
12: 対象値が偽
13: 条件値がいずれかの対象値を含む
14: 条件値が対象値に含まれない
15: 条件値と対象値の個数が等しい
16: 条件値が対象配信キャリアと等しい
17: 条件値が対象エラー回数と等しい
19: 条件値が対象アップロード日時と等しい
20: 対象値に何かしら記述されている（「データなし」の反対）
26: 対象日時が抽出実行日の前後一定期間の範囲（月単位）
29: 対象日時が抽出実行日の前後一定期間の範囲（日単位）

会員IDの配列 (object) or テキスト (object) or URL (object) or パスワード（平文） (object) or 郵便番号 (object) or 電話番号 (object) or テキストエリア (object) or 最終ホスト (object) or 最終REFERER (object) or 自動採番 (object) or メールアドレス (object) or 整数 (object) or 単一選択 (object) or 都道府県 (object) or 性別 (object) or 未既婚 (object) or はい/いいえ (object) or 複数選択肢 (object) or 日付 (object) or 登録日時 (object) or 更新日時 (object) or 一括処理日時 (object) or Array of クリックカウントフラグ (objects) or アップロード日時 (object) or 付加情報なし (object)

付加情報オブジェクト。

その構造は「条件のとりかた」と項目種別によって異なります。

One of

ids

required

Array of integers

会員IDの配列

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/delete_members

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/delete_members

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/delete_members

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/delete_members

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"password": "password",
"grouping": true,
"additional_condition": {"title": "APIで作成された抽出条件",
"grouping": true,
"conditions": {"regist_date": [5,
{"start_date": "2009-01-01"
}
],
"e_4": [4,
{"value": "@tricorn.co.jp"
}
],
"e_6": [5,
{"values": [1
]
}
],
"e_7": [13,
{"options": [3,
5
]
}
],
"e_11": [26,
{"calc_start_value": -1,
"calc_end_value": 1
}
]
}
}
}

Response samples

200
4xx
5xx

Content type

application/json

{"results": 10
}

条件に基づいて会員データを一括削除

指定された抽出条件に従って、会員を一括削除します。

必要権限

全てのアクセス権または操作のみ

監査ログ

一括削除

備考

「テキスト（暗号化）」項目が存在するデータベースにおいて、暗号項目鍵の利用権限を持たないログインユーザが会員の一括削除を行った場合でも削除可能です。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id required	integer データベースID
password required	string パスワード
condition_id	integer or null 抽出条件ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/delete_members_by_condition

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/delete_members_by_condition

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/delete_members_by_condition

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/delete_members_by_condition

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"password": "password",
"condition_id": 3
}

Response samples

200
4xx
5xx

Content type

application/json

{"results": 10
}

JSON API 専用 API

JSON API のみで利用できるAPI群です。

ファイル情報を渡し、stored_fileとして保存

ファイル情報を渡すと、その情報が stored_file として保存されます。

保存されたファイルは import_members APIで利用できます。

このAPIは、SOAP APIの getUploadUrl + ファイルアップロード用URLへのアップロード処理を一つのAPIコールにまとめた役割を果たします。

POST ボディは50 MB未満にしてください。

必要権限

(ファイルアップロードAPIの権限に準じます。通常は特別な権限なし)

備考

実際のファイルアップロード処理のステータス確認や、stored_file_id の取得は、このAPIのレスポンスや関連APIで行います。

Authorizations:

bearerAuth

Request Body schema: application/json
required

body required	string `import_members` で利用するファイルの⽂字列情報をUTF-8（LF）で格納してください。
file_name required	string アップロードするファイル名 `import_members` で利用する場合、.txt, .tsv, .csv いずれかの拡張子を指定してください。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/upload_stored_files

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/upload_stored_files

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/upload_stored_files

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/upload_stored_files

Request samples

Payload

Content type

application/json

{"body": "sr1@example.com,yamada1\nuser2@example.com,tanaka2\n",
"file_name": "test.csv"
}

Response samples

200
4xx
5xx

Content type

application/json

777

一括処理の結果ファイルを取得

一括処理IDを引き渡すと、その一括処理の結果ファイル（例: export_members の結果CSVファイルや import_members の結果ログファイル）を応答します。

このAPIの応答はJSONではなく、直接ファイル形式での応答となります。

必要権限

(結果ファイルダウンロード権限。getBatchJobResultUrl に準じます)

備考

結果の保存期間は7日間です。保存期間を経過していた場合はエラーとなります。

エラー

エラーコード	エラー説明	状況
`KR_API_F0305`	Batch Job Is Running.	一括処理はまだ実行中です。
`KR_API_F0306`	No Result File.	この一括処理にはダウンロードできる結果が存在しません。
`KR_API_F0307`	No Has Privilage To Download Result File.	結果ファイルをダウンロードする権限がありません。

Authorizations:

bearerAuth

Request Body schema: application/json
required

batch_job_id

required

integer

一括処理ID

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_batch_job_result

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_batch_job_result

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_batch_job_result

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_batch_job_result

Request samples

Payload

Content type

application/json

{"batch_job_id": 10
}

Response samples

4xx
5xx

Content type

application/json

{"error_code": "KR_API_F1004",
"error_desc": "Invalid Json.",
"message": "Detailed error message here."
}

投稿画像 API

投稿された画像に関連するAPI群です。

指定会員の投稿画像URLを取得

指定された会員の投稿画像情報（画像URL等）を取得します。

必要オプション

フォーム
画像投稿

必要権限

全てのアクセス権または参照のみおよび投稿画像管理メニュー

備考

API実行後にユーザが画像を更新した場合、URLで取得できる画像は更新前のものとなります。
会員は存在するが対象アルバムの投稿画像が存在しない場合は、該当会員の配列が空配列となります。
会員が存在しない場合は空配列を返します。
返値のexpireが各投稿画像URLの有効期限となります。有効期限の長さはKREISEL管理画面のシステム > セキュリティの「投稿画像差込記号URLの有効期限（API）」で設定可能です。
投稿画像URLの有効期限の起点はAPI実行時となります。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id required	integer データベースID
member_id required	integer 会員ID
album_ids	Array of integers or null アルバムIDの配列。未指定または空配列で渡すと全アルバムが対象。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_posted_image_urls

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_posted_image_urls

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_posted_image_urls

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_posted_image_urls

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"member_id": 2,
"album_ids": [3,
4
]
}

Response samples

200
4xx
5xx

Content type

application/json

{"2": {"3": {"url": "https://xxx/image1.png",
"file_name": "test2.png",
"mime_type": "image/png",
"size": 1000,
"date": "2025-01-30 12:00:00",
"expire": "2025-02-10 12:00:00"
},
"4": {"url": "https://xxx/image2.jpg",
"file_name": "test3.jpg",
"mime_type": "image/jpg",
"size": 1024,
"date": "2025-01-30 12:00:00",
"expire": "2025-02-10 12:00:00"
}
}
}

条件指定で複数会員の投稿画像URLを取得（ワンショット条件）

抽出条件を指定して、条件に合致した会員の投稿画像情報（画像URL等）を取得します。

必要オプション

フォーム
画像投稿

必要権限

全てのアクセス権または参照のみおよび投稿画像管理メニュー

備考

API実行後にユーザが画像を更新した場合、URLで取得できる画像は更新前のものとなります。
会員は存在するが対象アルバムの投稿画像が存在しない場合は、該当会員の配列が空配列となります。
返値のexpireが各投稿画像URLの有効期限となります。有効期限の長さはKREISEL管理画面のシステム > セキュリティの「投稿画像差込記号URLの有効期限（API）」で設定可能です。
投稿画像URLの有効期限の起点はAPI実行時となります。

エラー

例外コード	例外説明	状況
`KR_API_F0304`	Invalid Offset.	オフセット値が正しくありません。
`KR_API_F0229`	Condition Is Containing Encryption Element.	`condition_info` に「テキスト（暗号化）」項目を含めました。
`KR_API_F0230`	This Element Is Not Allowed For Sort Key.	`sort_key`に指定できない項目を指定しました。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id

required

integer

データベースID

required

object (ConditionParameter)

抽出条件の情報

title

required

string

抽出条件の名称

grouping

required

boolean

Enum: true false

項目間の条件の結合方法

true: AND検索
false: OR検索

required

object

項目ごとの条件。キーは項目名（id, regist_date, e_## など）、値は IndividualCondition スキーマで定義される配列です。

additional property

Array of items (個別条件) = 2 items

項目ごとの条件を指定します。

キーは項目名（id, regist_date, e_## など）です。

値は [条件のとりかた (integer), 付加情報 (object)] の形式の配列です。

「付加情報」の構造は項目種別と「条件のとりかた」により異なります。詳しくは「抽出条件のパラメータ化」を参照してください。

[0]

integer

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 19 20 26 29

条件のとりかた。

1: 条件を指定しない
2: 条件値が対象値と完全に一致する
3: 条件値が対象値の前方（先頭基準）に含まれる
4: 条件値が対象値の後方（末尾基準）に含まれる
5: 条件値が対象値に含まれる
6: 条件値が対象値と完全に異なる
7: 条件値が対象値の前方（先頭基準）に含まれない
8: 条件値が対象値の後方（末尾基準）に含まれない
9: 条件値が対象値に含まれない
10: 対象値に何も記述されていない
11: 対象値が真
12: 対象値が偽
13: 条件値がいずれかの対象値を含む
14: 条件値が対象値に含まれない
15: 条件値と対象値の個数が等しい
16: 条件値が対象配信キャリアと等しい
17: 条件値が対象エラー回数と等しい
19: 条件値が対象アップロード日時と等しい
20: 対象値に何かしら記述されている（「データなし」の反対）
26: 対象日時が抽出実行日の前後一定期間の範囲（月単位）
29: 対象日時が抽出実行日の前後一定期間の範囲（日単位）

会員IDの配列 (object) or テキスト (object) or URL (object) or パスワード（平文） (object) or 郵便番号 (object) or 電話番号 (object) or テキストエリア (object) or 最終ホスト (object) or 最終REFERER (object) or 自動採番 (object) or メールアドレス (object) or 整数 (object) or 単一選択 (object) or 都道府県 (object) or 性別 (object) or 未既婚 (object) or はい/いいえ (object) or 複数選択肢 (object) or 日付 (object) or 登録日時 (object) or 更新日時 (object) or 一括処理日時 (object) or Array of クリックカウントフラグ (objects) or アップロード日時 (object) or 付加情報なし (object)

付加情報オブジェクト。

その構造は「条件のとりかた」と項目種別によって異なります。

One of

ids

required

Array of integers

会員IDの配列

offset

required

integer

何番目の会員情報から取得するかのオフセット。最初の会員情報をオフセット0とする。

sort_key

required

integer

ソートの対象となる項目のID。会員IDの場合は0を指定。

order

required

boolean

ソートの順番。

true: 昇順
false: 降順"

album_ids

Array of integers or null

アルバムIDの配列。未指定または空配列で渡すと全アルバムが対象。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_posted_image_urls_by_oneshot_condition

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_posted_image_urls_by_oneshot_condition

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_posted_image_urls_by_oneshot_condition

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_posted_image_urls_by_oneshot_condition

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"condition_info": {"title": "APIで作成された抽出条件",
"grouping": true,
"conditions": {"regist_date": [5,
{"start_date": "2009-01-01"
}
],
"e_4": [4,
{"value": "@tricorn.co.jp"
}
],
"e_6": [5,
{"values": [1
]
}
],
"e_7": [13,
{"options": [3,
5
]
}
],
"e_11": [26,
{"calc_start_value": -1,
"calc_end_value": 1
}
]
}
},
"offset": 4,
"sort_key": 0,
"order": true,
"album_ids": [2,
3
]
}

Response samples

200
4xx
5xx

Content type

application/json

{"2": {"3": {"url": "https://xxx/image1.png",
"file_name": "test2.png",
"mime_type": "image/png",
"size": 1000,
"date": "2025-01-30 12:00:00",
"expire": "2025-02-10 12:00:00"
},
"4": {"url": "https://xxx/image2.jpg",
"file_name": "test3.jpg",
"mime_type": "image/jpg",
"size": 1024,
"date": "2025-01-30 12:00:00",
"expire": "2025-02-10 12:00:00"
}
}
}

既存抽出条件で複数会員の投稿画像URLを取得

既存の抽出条件IDを指定して、条件に合致した会員の投稿画像情報（画像URL等）を取得します。

必要オプション

フォーム
画像投稿

必要権限

全てのアクセス権または参照のみおよび投稿画像管理メニュー

備考

API実行後にユーザが画像を更新した場合、URLで取得できる画像は更新前のものとなります。
会員は存在するが対象アルバムの投稿画像が存在しない場合は、該当会員の配列が空配列となります。
返値のexpireが各投稿画像URLの有効期限となります。有効期限の長さはKREISEL管理画面のシステム > セキュリティの「投稿画像差込記号URLの有効期限（API）」で設定可能です。
投稿画像URLの有効期限の起点はAPI実行時となります。

エラー

エラーコード	エラー説明	状況
`KR_API_F0304`	Invalid Offset.	オフセット値が正しくありません。
`KR_API_F0230`	This Element Is Not Allowed For Sort Key.	sort_keyに指定できない項目を指定しました。

Authorizations:

bearerAuth

Request Body schema: application/json
required

member_table_id required	integer データベースID
condition_id required	integer 抽出条件ID
offset required	integer 何番目の会員情報から取得するかのオフセット。最初の会員情報をオフセット0とする。
sort_key required	integer ソートの対象となる項目のID。会員IDの場合は0を指定。
order required	boolean ソートの順番。 `true`: 昇順 `false`: 降順
album_ids	Array of integers or null アルバムIDの配列。未指定または空配列で渡すと全アルバムが対象。

Responses

カスタムドメイン未使用またはクリックカウントカスタムドメイン

https://krs.bz/{environmentId}/api/v1/get_posted_image_urls_by_condition

フォームカスタムドメイン（SSL）

https://{customDomainName}/api/v1/get_posted_image_urls_by_condition

試用環境（APItest）

https://apitest.krs.bz/{environmentId}/api/v1/get_posted_image_urls_by_condition

API検証環境（APIbeta）

https://apibeta.krs.bz/{environmentId}/api/v1/get_posted_image_urls_by_condition

Request samples

Payload

Content type

application/json

{"member_table_id": 1,
"condition_id": 1,
"offset": 4,
"sort_key": 0,
"order": true,
"album_ids": [2,
3
]
}

Response samples

200
4xx
5xx

Content type

application/json

{"2": {"3": {"url": "https://xxx/image1.png",
"file_name": "test2.png",
"mime_type": "image/png",
"size": 1000,
"date": "2025-01-30 12:00:00",
"expire": "2025-02-10 12:00:00"
},
"4": {"url": "https://xxx/image2.jpg",
"file_name": "test3.jpg",
"mime_type": "image/jpg",
"size": 1024,
"date": "2025-01-30 12:00:00",
"expire": "2025-02-10 12:00:00"
}
}
}

KREISEL JSON API (202509)

概要

認証

環境情報取得 API

環境名を取得

必要オプション

必要権限

監査ログ

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

データベース関連 API

会員データベースの一覧を取得

必要オプション

必要権限

監査ログ

備考

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

会員データベース項目一覧の情報を取得

必要オプション

必要権限

監査ログ

備考

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

特定の会員データベース項目の詳細設定を取得

必要オプション

必要権限

監査ログ

備考

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

会員データベースをロックし、他の処理実行を防ぐ

必要オプション

必要権限

監査ログ

備考

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ロックされた会員データベースのロックを解除する

必要オプション

必要権限

監査ログ

備考

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

会員情報関連API

会員情報で検索し、対応する会員IDを取得

必要オプション

必要権限

監査ログ

備考

エラー

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

指定された会員IDの会員情報を取得

必要オプション

必要権限

監査ログ

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required