[엔터프라이즈] 외부 회원 연동 가이드

일부 API는 2024년 11월 6일(수) 업데이트 되었습니다. [공지보기]

아래 가이드를 통해, 고객사에서 기존에 보유하고 있던 회원정보를 이용하여 샵바이 쇼핑몰에서 로그인 가능합니다. 쇼핑몰 회원 인증/ 휴면회원 해제/ 회원 탈퇴 연동을 진행해보세요.

※ 외부 회원 연동은 토큰 기반 연동 방식을 제공합니다.

※ 외부 회원 연동 시 쇼핑몰회원(간편 로그인 포함) 가입은 불가합니다.

오로라 기본 스킨에서는 인증 관리를 쉽게 할 수 있는 유틸리티를 제공합니다. 자세한 내용은 인증관리 유틸리티 사용법(외부 회원 연동) 가이드를 참고하세요.

(연동방식) 토큰 기반 연동

1. 기본 FLOW

2. 쇼핑몰 사용자 인증

▶ 요약
shopby API를 사용하기 위해서는 전용 accessToken이 필요합니다.
해당 토큰을 발행하기 위해서, 몰의 로그인 토큰을 검증하고 회원을 조회하는 API의 개발이 필요합니다.
API 개발 후, [NHN커머스> 고객센터> 1:1문의]를 통해 개발된 API를 NHN커머스에 등록요청 바랍니다. 

아래 2가지 정보를 전달주시길 바랍니다.
(1) 쇼핑몰 번호 
    * 쇼핑몰번호는 서비스어드민> 서비스관리> 쇼핑몰관리에서 확인 가능합니다. 
(2) check-token URI(로그인 연동을 위한 URI)
(3) authorizationType : (기본값은 타입 미포함)

▶ 외부아이디 로그인 토큰으로 샵바이 토큰 획득 API 바로가기

외부아이디(오픈아이디 포함) 로그인을 통한 샵바이 토큰 획득 API에 대한 안내 입니다.

고객사의 회원 시스템의 토큰으로 샵바이 토큰을 획득하기 위한 연동 API 스펙

▶ 쇼핑몰 FE -> 샵바이 서버 요청

https://docs.shopby.co.kr/?url.primaryName=auth/#/Authentication/post-oauth-openid API 를 이용하여 고객사의 토큰을 이용해 샵바이 토큰을 발급받을 수 있습니다.

해당 API 요청 시 아래의 값은 필수값으로 전송해야 합니다.

provider : ncpstore
openAccessToken : 외부입점사에서 발급한 accessToken

▶ 샵바이서버 -> 고객사 회원시스템 인증 요청

고객사에서는 샵바이의 스팩에 맞는 request param과 response 에 맞는 API를 제공해야 합니다.

예시) GET https://abc.com/id?token={token}

요청의 형태는 위 URI 와 같으며 queryParam 으로 token 이라는 파라메터에 고객사 로그인 토큰 값을 전달합니다. URI는 각 고객사에 맞게 수정 가능합니다.

로그인 토큰을 Header에 Authorization 필드로도 전달합니다. 아래 두 가지 형태 모두 지원합니다.
- 타입 포함 - Authorization : {type} {token} ex) Authorization : Bearer abc123
- 타입 미포함 - Authorization : {token} ex) Authorization : abc123

▶ Response

(1) 유효한 토큰인 경우

유효한 토큰이면 성공(200)으로 응답
HTTP Status 200 OK

항목

타입

필수여부

제한

Null인 경우

설명

String

최대 50자

Null 불가

업체에서 관리하는 회원의 유일값

(전화번호 등 변동가능한 값 사용이 어렵습니다)

name

String

최대 50자

기존 저장값 유지

사용자 이름

adultCertified

Boolean

기존 저장값 유지

성인 인증 여부

gradeNo

Number

기존 저장값 유지

회원 등급 (사전에 등록 필요)

groupNos

Array

기존 저장값 유지

회원 그룹 (사전에 등록 필요)

nickname

String

최대 30자

기존 저장값 유지

사용자 별명, 별칭

String

최대 50자

기존 저장값 유지

이메일

phone

String

숫자만

(- 제거 필수)

기존 저장값 유지

휴대전화번호

nation

String

기존 저장값 유지

KR, US, JP, CN / 기본값은 쇼핑몰 설정을 따름

privacyPolicyAgreed

Boolean

기존 저장값 유지

본인인증여부

pushPolicyAgreed

Boolean

기존 저장값 유지

앱푸시동의 여부 - 샵바이에서 사용하지 않음

smsPolicyAgreed

Boolean

기존 저장값 유지

광고성sms 수신동의 여부

emailPolicyAgreed

Boolean

기존 저장값 유지

광고성email 수신동의 여부

gender

String

기존 저장값 유지

F, M / 성별(F: 여성, M: 남성)

String

기존 저장값 유지

birthday

String

'yyyyMMdd' 형식

기존 저장값 유지

생년월일

businessName

String

최대 50자

기존 저장값 유지

사업자명

businessRegistrationNumber

String

10자 ('-' 포함 12자)

기존 저장값 유지

사업자등록번호 예시) * 하이픈(-) 미포함: 1234567890 * 하이픈(-) 포함: 123-45-67890

extraJson

String

JSON String

기존 저장값 유지

추가 정보 (입점사 회원 커스텀 정보)

zipCode

String

최대 50자

기존 값 유지

우편번호

streetAddress

String

최대 500자

기존 값 유지

도로명 주소

streetAddressDetail

String

최대 500자

기존 값 유지

도로명 주소 상세

landLotAddress

String

최대 500자

기존 값 유지

지번 주소

landLotAddressDetail

String

최대 500자

기존 값 유지

지번 상세 주소

city

String

최대 500자

기존 값 유지

시, 도

state

String

최대 500자

기존 값 유지

구, 군

현재 샵바이에서는 만 14세 미만 회원의 회원가입을 제한하고 있으나, 외부회원 연동인 경우에 한하여 허용하고 있습니다.

외부회원연동은 고객사 회원의 시스템을 기반으로 샵바이에 연동하는 것이므로 만 14세 미만 회원이 존재하는 경우, 법정대리인 동의 절차를 모두 완료하신 뒤 연동해 주세요.

해당 가이드 미숙지로 발생하는 이슈에 대한 책임은 고객사에 있으니 반드시 유의 부탁드립니다.

외부회원연동의 경우, 샵바이 내 smsPolicyAgreed, emailPolicyAgreed 값이 저장/변경된 시점을 기준으로 동의/거부일시로 처리되어, 실제 회원이 동의/거부한 시점과 다를 수 있습니다.

따라서 정확한 동의일 관리 및 안내를 위해 광고성 수신 동의여부에 대한 법적고지는 고객사 회원의 시스템에서 진행해주셔야 합니다.

샵바이 관리자에서 회원등급과 회원그룹을 설정 후 NHN커머스 측으로 요청 시 groupNos 값을 전달해 드립니다.

extraJson 항목에, 고객사에서 추가적으로 저장하고 싶은 회원정보를 JsonString형태로 샵바이에 전달가능합니다. 이렇게 전달된 extraJson정보는 회원정보 조회하기 shop API와 server API에서 응답값 내 additionalInfo로 바이패스되어 전달됩니다.

businessName과 businessRegistrationNumber 2개 모두 값이 있어야 최초 등록 가능합니다. 2개 항목 모두 ""(empty)로 보내면 기존 등록된 내용이 삭제됩니다.

Example

{
    "id" : "898010",
    "adultCertified" : false,
    "name" : "Jieun Lee",
    "nickname" : "아이유",
    "email" : "[email protected]",
    "phone" : "01012348989",
    "nation" : "KR",
    "privacyPolicyAgreed" : true,
    "pushPolicyAgreed" : true,
    "smsPolicyAgreed" : false,
    "emailPolicyAgreed" : false,
    "gender" : "F",
    "ci" : "abcde",
    "birthday" : "19990101",
    "businessName" : "NHN커머스",
    "businessRegistrationNumber" : "1231212345",
    "extraJson" : "{\"job\":\"가수\",\"hobby\":[\"운동하기\",\"영화보기\"]}"
    "zipCode" : "08390"
    "city" : "서울특별시"
    "state" : "구로구"
    "streetAddress" : "디지털로26길 43"
    "streetAddressDetail" : "R동 6, 7층"
    "landLotAddress" : "구로동 212-8"
    "landLotAddressDetail" : "R동 6, 7층"
 }

고객(회원)이 설정한 서비스에 대한 마케팅 동의 여부 등을 위 API의 응답으로 보내주시면 쇼핑몰에 진입할 때마다

회원 정보를 응답 값으로 매번 변경합니다.

(2) 기타 고객사 API 측 오류인 경우

나머지 고객사 API 측 오류면 고객사에서 내려준 response 를 그대로 message 에 포함하여 오류(400)로 응답합니다.
샵바이 토큰 발행 api (https://docs.shopby.co.kr/?url.primaryName=auth/#/Authentication/post-oauth-openid ) 의 응답으로 유효하지 않은 토큰일 경우에도 오류(400)로 응답합니다.

3. 회원탈퇴

▶ 외부회원 탈퇴 API 바로가기

앱에서 회원탈퇴할 경우, server api의 회원 탈퇴 API (https://server-docs.shopby.co.kr/?url.primaryName=member/#/Profile/delete-profile) 호출을 반드시 해주세요.

4. 휴면처리

▶ 휴면처리 API 바로가기

앱에서 휴면처리될 경우, server api의 휴면처리 API (https://server-docs.shopby.co.kr/?url.primaryName=member/#/Profile/put-profile-dormant) 호출을 반드시 해주세요.

5. 회원 등급 평가

외부 회원 연동을 사용하시면서 동시에 샵바이에서 제공하는 회원 등급 평가를 사용하시고 싶으실 경우, 회원등급(gradeNo) 값을 null 로 보내면 기존에 저장된 값을 업데이트 하지 않고 그대로 유지하므로 샵바이에서 제공하는 회원등급을 사용하실 수 있습니다.
외부 연동 회원 데이터로 동기화 하고 싶으실 경우,
1. 샵바이 관리자 내 '회원 등급 관리' 메뉴에서 [등급 평가 설정] 버튼을 클릭하시어 자동 등급 평가 사용을 '사용 안 함' 처리해주세요.
2. 연동 데이터 전달 시에는 회원등급(gradeNo) 값을 해당 쇼핑몰의 groupNo로 전달해 주세요. * 위 경우에는 샵바이에서 등급 평가를 '사용함'으로 설정 하더라도 해당 회원이 쇼핑몰에 로그인하는 시점에 외부 연동 회원 데이터로 동기화 되므로 유의바랍니다.

Previous[엔터프라이즈] 이니렌탈(렌탈결제) API 화면가이드 Next[엔터프라이즈] 외부 적립금 전환 가이드

Last updated 5 days ago

Was this helpful?