고객 등록

고객 정보를 등록하는 API입니다. 이전 시스템의 고객 데이터를 이전하거나, 오프라인/제휴 유입 고객을 등록할 수 있습니다.

POST

https://api.bootapi.com/v1/users/join

회원

쇼핑몰에 직접 가입하여 로그인 계정을 보유한 사용자

비회원

판매자가 주문 링크 발송을 위해 등록한 결제 전용 사용자

기업 그룹

동일 기업 소속 사용자를 묶어 구독/결제를 통합 관리

개인 그룹

회원 가입 시 자동 생성되는 개인 전용 그룹

user_group_id를 지정하면 기업 회원, 미지정 시 개인 회원으로 등록됩니다.

고객 정보 구성

Server

등록할 고객의 정보를 구성합니다.

등록 전에 중복 체크 API로 아이디/이메일 중복을 확인하세요.

필수 파라미터

login_idstring필수로그인 아이디 (영문/숫자, 5~30자)
login_pwstring필수로그인 비밀번호
namestring필수고객 이름
emailstring필수이메일 주소 (쇼핑몰 설정에 따라 필수)
phonestring필수휴대폰 번호 (쇼핑몰 설정에 따라 필수)

선택 파라미터

external_uidstring외부 고유 ID (ex_uid) - 가맹점에서 사용하는 고유 식별자
telstring유선 전화번호
birthstring생년월일 6자리
gendernumber성별 (0: 여자, 1: 남자)

API 요청

Server

Access Token을 발급받은 후 고객 등록 API를 호출합니다.

요청 흐름

Access Token 발급

createUser() 호출

user_id 수신

응답 처리

Server

응답의 user_id를 저장하여 이후 고객 관리에 사용합니다.

주요 응답 필드

user_idstring고객 고유 번호 (이후 API에서 사용)
external_uidstring외부 고유 ID (등록 시 uid로 지정한 값)
login_idstring등록된 로그인 아이디
membership_typenumber회원 유형 (1: 회원)
statusnumber계정 상태 (1: 활성)

활용 예시

user_id 또는 external_uid로 주문서 생성 시 고객 지정

user_id 또는 external_uid로 로그인 토큰 발급

external_uid로 상세조회, 수정, 삭제 가능

에러 코드

API_PARAM_INVALID

필수 파라미터를 입력해주세요.

필수 파라미터를 확인하세요.

USER_ID_BLANK

로그인 아이디를 입력해주세요.

login_id 파라미터를 확인하세요.

USER_ID_INVALID

로그인 아이디 형식이 올바르지 않습니다.

영문/숫자 5~30자 형식으로 입력하세요.

USER_ID_EXIST

이미 존재하는 로그인 아이디입니다.

다른 로그인 아이디를 사용하세요.

USER_EMAIL_EXIST

이미 존재하는 이메일입니다.

다른 이메일 주소를 사용하세요.

USER_NAME_BLANK

고객 이름을 입력해주세요.

name 파라미터를 확인하세요.

언어

Node.js SDK 설치

1. npm으로 설치

npm install --save @bootpay/backend-js

2. Import

ES6 Module (권장)

import { BootpayCommerce } from '@bootpay/backend-js'

CommonJS

const { BootpayCommerce } = require('@bootpay/backend-js')

3. 초기화

const commerce = new BootpayCommerce({
    client_key: 'YOUR_CLIENT_KEY',
    secret_key: 'YOUR_SECRET_KEY',
    mode: 'development' // 'production' | 'development' | 'stage'
})

// 토큰 발급
await commerce.getAccessToken()

참고: client_key와 secret_key는 부트페이 관리자에서 확인할 수 있습니다.