メインコンテンツまでスキップ

メールアドレスで会員を検索する

POST /api/v1/lookup_member_id を利用すると、重複キー項目として設定されているメールアドレスを元に会員データを検索し、会員 ID を取得できます。

この API を利用するには、検索対象のデータベースで、検索に利用する項目(この場合はメールアドレス)に「重複キー」が設定されている必要があります。

注意点
  • 重複キーが複数設定されているデータベースでは、API リクエスト時にすべての重複キー項目を指定する必要があります。
  • メールアドレス項目が重複キーでない場合は POST /api/v1/get_member_infos_by_oneshot_condition を利用して検索します。

パラメータ

キーデータ型必須説明
member_table_idIntegerデータベースID。
member_infoObject検索条件となる会員情報。キーに項目名(e_XX)、値に検索値を指定します。

レスポンス

検索に合致した会員の ID を返します。存在しない場合は 0 が返ります。

サンプルコード

データベース ID 1 のメールアドレス項目(項目 ID 6)に登録されている「foo@example.com」という会員を検索します。

<?php

$apiToken = getenv("API_TOKEN");
$environmentId = getenv("ENV_ID");
$url = "https://krs.bz/$environmentId/api/v1/lookup_member_id";

$data = [
'member_table_id' => 1,
'member_info' => [
'e_6' => 'foo@example.com',
],
];

$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) {
$memberId = json_decode($response, true);
echo '会員ID : ', $memberId, PHP_EOL;
} else {
// 例外発生時
echo 'Error: ', $response, PHP_EOL;
}

実行結果

  • 会員が存在する場合

    会員ID : 1
  • 会員が存在しない場合

    会員ID : 0
  • メールアドレス項目が重複キーでない場合

    Error: {"error_code":"KR_API_F0303","error_desc":"All Unique Key Elements Not Specified."}