회원가입 또는 고객 등록 전에 특정 필드 값의 중복 여부를 확인하는 API예요.
API 엔드포인트
GET
https://api.bootapi.com/v1/users/join/:key?pk=:valueBasic Auth요청 파라미터
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
key |
String | 필수 | 중복 확인 대상 필드 |
value |
String | 필수 | 확인할 값 (pk 쿼리로 전달) |
key 옵션
| key 값 | 설명 | 예시 |
|---|---|---|
email-exist |
이메일 | test@bootpay.co.kr |
phone-exist |
휴대폰 번호 | 01012345678 |
id-exist |
로그인 아이디 | testuser123 |
uid-exist |
외부 고유 ID(ex_uid) | user_12345 |
group-business-number-exist |
사업자등록번호 | 1234567890 |
코드 예제
curl -H "Content-Type: application/json" \
-H "Authorization: Basic {base64(client_key:secret_key)}" \
-X GET "https://api.bootapi.com/v1/users/join/email-exist?pk=test@bootpay.co.kr"bashconst { BootpayCommerce } = require('@bootpay/backend-js')
const commerce = new BootpayCommerce({
client_key: '{client_key}',
secret_key: '{secret_key}'
})
const response = await commerce.user.checkExist({
key: 'email-exist',
value: 'test@bootpay.co.kr'
})
console.log(response)javascriptfrom bootpay_backend.commerce import BootpayCommerce
commerce = BootpayCommerce(
client_key='{client_key}',
secret_key='{secret_key}'
)
response = commerce.user.check_exist(
key='email-exist',
value='test@bootpay.co.kr'
)
print(response)python<?php
require_once 'vendor/autoload.php';
use Bootpay\ServerPhp\BootpayCommerceApi;
$bootpay = new BootpayCommerceApi('{client_key}', '{secret_key}');
$response = $bootpay->user->checkExist([
'key' => 'email-exist',
'value' => 'test@bootpay.co.kr'
]);
print_r($response);phpimport kr.co.bootpay.store.BootpayStore;
import kr.co.bootpay.store.model.request.TokenPayload;
import kr.co.bootpay.store.model.response.BootpayStoreResponse;
TokenPayload tokenPayload = new TokenPayload("{client_key}", "{secret_key}");
BootpayStore bootpay = new BootpayStore(tokenPayload);
BootpayStoreResponse response = bootpay.user.checkExist("email-exist", "test@bootpay.co.kr");
System.out.println(response.getData());javacommerce = BootpayStore::Api.new(
client_key: '{client_key}',
secret_key: '{secret_key}'
)
response = commerce.external_user_check_exist(
key: 'email-exist',
value: 'test@bootpay.co.kr'
)
puts responserubyimport (
"fmt"
"github.com/bootpay/backend-go/bootpay"
)
commerce := bootpay.NewCommerceApi("{client_key}", "{secret_key}")
response, err := commerce.User.CheckExist(map[string]interface{}{
"key": "email-exist",
"value": "test@bootpay.co.kr",
})
if err != nil {
fmt.Println(err)
return
}
fmt.Println(response)gousing Bootpay.Commerce;
var commerce = new BootpayCommerceApi("{client_key}", "{secret_key}");
var response = await commerce.User.CheckExist(new {
key = "email-exist",
value = "test@bootpay.co.kr"
});
Console.WriteLine(response);csharp응답
{
"exist": false
}json응답 파라미터
| 파라미터 | 타입 | 설명 |
|---|---|---|
| exist | Boolean | 해당 값이 이미 등록되어 있으면 true, 없으면 false |
에러 코드
공통 에러
인증·권한 관련 에러는 에러 코드표를 참고해요.
| 코드 | 메시지 | 대처 방법 |
|---|---|---|
API_PARAM_INVALID |
필수 파라미터를 입력해요 | key, pk 값을 확인해요 |