保存済みの検索条件で検索する
KREISEL の管理画面で予め作成・保存した「抽出条件」を使って、会員データを検索するには、 POST /api/v1/get_member_infos_by_condition を利用します。毎回同じ条件で検索する場合に便利です。
抽出条件は、KREISEL 管理画面の[会員データ]>[抽出条件管理]から作成できます。作成した抽出条件には一意の「抽出条件 ID」が割り当てられます。
ヒント
抽出条件は POST /api/v1/add_condition API を使ってプログラムから作成することも可能です。
パラメータ
| キー | データ型 | 必須 | 説明 |
|---|---|---|---|
member_table_id | Integer | ○ | データベースID。 |
condition_id | Integer | ○ | KREISEL管理画面で作成した抽出条件のID。 |
offset | Integer | ○ | 検索結果の取得開始位置。 |
sort_key | Integer | ○ | 結果の並び替えの基準となる項目ID。 |
order | Boolean | ○ | true で昇順、false で降順にソートします。 |
サンプルコード
データベース ID 1 に対し、抽出条件 ID 2 を使って会員を検索します。
- PHP
<?php
$apiToken = getenv("API_TOKEN");
$environmentId = getenv("ENV_ID");
$url = "https://krs.bz/$environmentId/api/v1/get_member_infos_by_condition";
$data = [
'member_table_id' => 1,
'condition_id' => 2,
'offset' => 0,
'sort_key' => 0, // 会員IDでソート
'order' => true, // 昇順
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer ' . $apiToken,
'Content-Type: application/json',
]);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($httpCode === 200) {
$members = json_decode($response, true);
if (!empty($members)) {
foreach ($members as $member) {
// e_6 はメールアドレス項目
printf(
"会員ID : %s\t%s%s",
$member['id'],
$member['e_6'],
PHP_EOL
);
}
} else {
echo '該当会員は存在しませんでした', PHP_EOL;
}
} else {
echo 'Error: ', $response, PHP_EOL;
}
実行結果
-
該当する会員が存在した場合
会員ID : 1 foo@example.com
会員ID : 5 bar@example.com
... -
該当する会員が存在しない場合
該当会員は存在しませんでした