신규 비즈니스 생성 API

플랫폼 서비스에서 개별 유저가 전자서명을 생성하고 관리할 수 있도록 비즈니스 계정 생성 API를 제공합니다.

POST kit-api/v1/business

Method: POST Endpoint: kit-api/v1/business

Example

{
  "input": {
    "user": {
      "email": "[e-mail]",
      "password": "thisistestpassword"
    },
    "profile": {
      "name": "ABC 컴퍼니"
    },
    "customConfig": {
      "customerCustomName": "매장"
    }
  }
}

Request Body 파라미터

1. user

Key	Description	Required
email	새로 생성할 비즈니스의 이메일. 추후 해당 비즈니스로 서명을 요청하는 경우 서명 요청자의 이메일로 적용됨.	yes
password	영문과 숫자를 포함한 8자리 이상의 값	yes

2. profile

Key	Description	Required
name	기업명	yes
registrationNumber	사업자등록번호	no
ceo	대표자명	no
address	사업자주소	no

3. customConfig

Key	Description	Required
customerCustomName	커스텀할 고객명	no

Response

{
  "ok": true,
  "data": {
    "apiKey": "API_KEY_STRING" // API key 값을 저장해서 사용해 주세요.
  }
}

{
  "ok": false, // api 실패
  "message": "error message", // Error가 존재하면 message(string)로 전달
  "errorCode": "ERROR_CODE"
}

Error Codes

Status Code	Error Code	Description
400	INVALID_REQUEST_INPUT	파라미터가 잘못된 경우
400	INVALID_PASSWORD_MINIMUM_LENGTH	password가 최소 길이 미만인 경우
400	INVALID_REQUEST_PARAM	프로필에 이름이 누락된 경우
400	INVALID_CUSTOMER_CUSTOM_NAME	customerCustomName이 생성 규칙을 벗어난 경우
400	EXISTING_EMAIL	email이 이미 존재하는 경우
500	FAILED_CREATE_SIGNUP	사용자 생성 과정에서 알 수 없는 에러가 발생한 경우
500	FAILED_CREATE_BUSINESS	비즈니스 생성 과정에서 알 수 없는 에러가 발생한 경우