회원 등록 | Bootpay 커머스 매뉴얼

기업 그룹에만 넣을 수 있어요. 이미 등록된 회원은 다시 넣지 못해요.

기업 그룹(UserGroup)에 회원을 등록해요. 같은 기업에 여러 회원을 등록하여 주문과 구독 내역을 관리할 수 있어요.

API 엔드포인트

POSThttps://api.bootapi.com/v1/user-groups/:user_group_id/userBasic Auth

필요 scope: manager:user_group_add_user (Bootpay-Role 헤더로 역할 부분 변경 가능). 대상 회원은 요청 본문으로 지정하며 회원 JWT는 읽지 않아요. v1 회원 그룹 API 상세 명세에서 인증과 응답 필드를 확인해요.

기업 그룹에만 회원을 등록할 수 있어요.
개인 그룹에는 회원 등록이 불가능해요.
이미 그룹에 등록된 회원은 재등록할 수 없어요.

요청 파라미터

파라미터	타입	필수	설명
`user_group_id`	String	필수	기업 그룹 ID 또는 그룹 생성 때 지정한 `uid` (URL 경로)
`user_id`	String	필수	추가할 회원의 `_id`(24자리 ObjectId) 또는 가맹점 회원 ID(`ex_uid`). `user_ex_uid` 로 보내도 돼요. 로그인 ID 로는 찾지 않아요 (요청 본문)

코드 예제

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

const commerce = new BootpayCommerce({
    client_key: '{client_key}',
    secret_key: '{secret_key}'
});

const userGroupId = '67e2052b03d0cb4e4117b0af';
const response = await commerce.userGroup.addUser(userGroupId, {
    user_id: '67e0f47d03d0cb4e4117b083'
});
console.log(response);javascript

from bootpay_backend.commerce import BootpayCommerce

commerce = BootpayCommerce('{client_key}', '{secret_key}')
user_group_id = '67e2052b03d0cb4e4117b0af'
response = commerce.user_group.add_user(user_group_id, {
    'user_id': '67e0f47d03d0cb4e4117b083'
})
print(response)python

use Bootpay\ServerPhp\BootpayCommerceApi;

$commerce = new BootpayCommerceApi("{client_key}", "{secret_key}");
$userGroupId = '67e2052b03d0cb4e4117b0af';
$response = $commerce->userGroup->addUser($userGroupId, [
    'user_id' => '67e0f47d03d0cb4e4117b083'
]);
print_r($response);php

import 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).withToken();
String userGroupId = "67e2052b03d0cb4e4117b0af";
String userId = "67e0f47d03d0cb4e4117b083";

BootpayStoreResponse response = bootpay.userGroup.userCreate(userGroupId, userId);
System.out.println(response.getData());java

require 'bootpay'

commerce = BootpayStore::RestClient.new(client_key: '{client_key}', secret_key: '{secret_key}')
user_group_id = '67e2052b03d0cb4e4117b0af'
response = commerce.add_user_to_group(
  user_group_id: user_group_id,
  user_id: '67e0f47d03d0cb4e4117b083'
)
puts responseruby

commerce := bootpay.NewCommerceApi("{client_key}", "{secret_key}")
userGroupId := "67e2052b03d0cb4e4117b0af"
response, err := commerce.UserGroup.AddUser(userGroupId, map[string]interface{}{
    "user_id": "67e0f47d03d0cb4e4117b083",
})
fmt.Println(response)go

using Bootpay.Commerce;

var commerce = new BootpayCommerceApi("{client_key}", "{secret_key}");
var userGroupId = "67e2052b03d0cb4e4117b0af";
var response = await commerce.UserGroup.AddUser(userGroupId, new {
    user_id = "67e0f47d03d0cb4e4117b083"
});
Console.WriteLine(response);csharp

응답

성공 응답

HTTP 200, 본문 없음. 추가된 회원은 그룹의 구성원이 돼요. 제거된 회원을 다시 추가하면 소속이 활성화돼요.

에러 코드

인증·권한 관련 에러는 에러 코드표를 참고해요.

코드	메시지	대처 방법
`USER_NOT_FOUND`	회원정보가 없어요. 다시 확인해요.	user_id를 확인해요
`REQUIRED_PARAMETER_IS_MISSING`	필수 파라미터가 없어요.	`user_id` 를 요청 본문에 넣어요
`USER_GROUP_NOT_FOUND`	회원 그룹 정보를 찾지 못했어요. 다시 로그인해요.	user_group_id를 확인해요
`USER_ALREADY_IN_GROUP`	사용자가 이미 그룹에 속해있어요.	그룹 멤버 목록을 확인해요
`USER_GROUP_IS_NOT_CORPORATE`	해당 그룹은 법인 그룹이 아니에요.	기업(`2`) 그룹 ID 인지 확인해요. 개인·부서 그룹에는 넣을 수 없어요

USER_NOT_FOUND 는 HTTP 404로 반환돼요. 없는 회원, 다른 몰의 회원, 탈퇴한 회원을 추가하려 할 때 확인해요.