SDK 사용 가이드

SDK 사용 가이드

스크립트에서 SDK를 사용할 수 있도록 고도몰 모든 상점에는 아래의 스크립트가 설치되어 있습니다.

<script src="//obs-address/godomall-sdk.js" onload="GodomallSDK.setup()">
</script>

SDK 사용 시에는 위 스크립트가 완전히 로드된 이후에 실행될 수 있도록 반드시 다음과 같이 defer 처리를 해주셔야 합니다. defer 처리를 하지 않는 경우 오류가 발생할 수 있습니다.

<script defer>
    var mySDK = GodomallSDK.init('SystemKey');
    mySDK.getMemberProfile(function(err, res) {
    });
</script>

GodomallSDK.init('시스템키') 스크립트를 삽입할 때마다 새로운 객체가 생성됩니다.

결과정보

SDK 실행 시 결과는 아래와 같이 전달됩니다.

/**
 * 조회 및 처리 실패 / err
 * return {}
 */
{
    name: '오류 명칭',
    kind: '오류 종류',
    status: 'HTTP 상태 코드',
    message: '오류 메시지',
    data: {전체 오류 정보}
}

/**
 * 조회 및 처리 성공 / res
 * return {} or []
 */
// 사용 메소드에 따라 {}객체, []배열로 전달

메소드 구조

기본구조에서 추가 파라미터가 없을 경우 version = '1.0' 으로 고정됩니다.

// 기본 구조
mySDK.[메소드](callback)

// 추가 파리미터가 있을 경우의 구조
mySDK.[메소드]({ 추가 파라미터 }, callback)

SDK 목록

사용 가능한 SDK는 다음과 같습니다.

변수명	설명
getMemberSummary	회원 요약 정보
getMemberProfile	회원 프로필
getMallInfo	쇼핑몰 식별 정보
getMallLocation	접속 페이지 정보
getGoods	상품 번호로 상품 상세 정보 조회

SDK 목록 상세

회원 요약 정보

제공 데이터

필드명	데이터 형식	설명
totalCartGoodsCount	number	장바구니 총 개수 (상품 기준)
totalCartCount	number	장바구니 총 개수 (상품 옵션 기준)
totalOrderAmount	number	총 주문 금액
totalOrderGoodsCount	number	총 주문 상품 개수
totalPaymentAmount	number	총 결제 금액
usableCouponCount	number	사용 가능한 쿠폰 개수
totalCartQuantity	number	장바구니 수량 합계
totalOrderCount	number	총 주문 수
totalOrderGoodsQuantity	number	주문 상품 수량 합계

사용 예시

/*
 새로 생성되는 객체의 변수명은 반드시 systemKey를 발급받은 앱의 일련번호를 기재해 주셔야 합니다.
*/

<script defer>    
    var 변수명_SDK = GodomallSDK.init('systemKey');
    변수명_SDK.getMemberProfile(function(err, res) {
        if (err) {
            console.log(err.name, err.kind, err.data, err.status, err.message);
        } else {
            console.log(res);
        }
    });
    변수명_SDK.getMemberSummary(function(err, res) {
        if (res) {
            // 필요한 코드 작성
        }
    });
</script>

회원 프로필

제공 데이터

필드명	데이터 형식	설명
sno	number	회원번호
id	string	회원 아이디
name	string	성명
email	string	이메일
cellPhone	string	휴대전화번호
mileage	number	적립금
deposit	number	예치금
grade	array	회원 등급 정보
sno	number	회원 등급 번호
name	string	회원 등급명
age	number	만 나이
gender	string	성별 - MALE : 남성 - FEMALE : 여성 - UNKNOWN : 모름
zipcode	string	우편번호
address	string	주소
addressDetail	string	상세주소
adultFlag	string	성인인증여부 - Y : 인증완료 - N : 미인증
mailingFlag	string	이메일 수신여부 - Y : 수신허용 - N : 수신거부
smsFlag	string	SMS 수신여부 - Y : 수신허용 - N : 수신거부
signupDateTime	string	가입 일시

사용 예시

/* 
새로 생성되는 객체의 변수명은 반드시 systemKey를 발급받은 앱의 일련번호를 기재해 주셔야 합니다.
*/

<script defer>
    var 변수명_SDK = GodomallSDK.init('systemKey');
    변수명_SDK.getMemberProfile(function(err, res) {
        if (err) {
            오류 핸들링이 필요하다면 코드 작성
        } else if (res) {
            // 필요한 코드 작성
        }
    });
</script>

쇼핑몰 식별 정보

제공 데이터

필드명	데이터 형식	설명
mallDomain	string	쇼핑몰 도메인
mallNm	string	쇼핑몰 명
mallNmEng	string	쇼핑몰 영문 명
mallUsageStatus	array	몰 사용 여부 - Y : 사용 - N : 미사용
kr	string	국문몰 사용 여부 - Y : 사용 - N : 미사용
us	string	영문몰 사용 여부 - Y : 사용 - N : 미사용
cn	string	중문몰 사용 여부 - Y : 사용 - N : 미사용
jp	string	일문몰 사용 여부 - Y : 사용 - N : 미사용

※ 튜닝 상점의 경우 쇼핑몰명 (mallNm), 쇼핑몰영문명 (mallNmEng), 해외몰 사용 여부 (mallUsageStatus)는 응답되지 않을 수 있습니다.

사용 예시

<script defer>
    var 변수명_SDK = GodomallSDK.init('systemKey');
    변수명_SDK.getMallInfo(function(err, res) {
        if (res) {
            // 필요한 코드 작성
        }
    });
</script>

접속 페이지 정보

제공 데이터

필드명	데이터 형식	설명
path	string	현재 경로 (기본 도메인 제외) ex. /member/join_method.php
pathSegments	array	현재 경로에 대한 배열 정보 ex. goods, member,join_method..

사용 예시

<script defer>
    var 변수명_SDK = GodomallSDK.init('systemKey');
    변수명_SDK.getMallLocation(function(err, res) {
        if (res) {
            // 필요한 코드 작성
        }
    });
</script>

상품 번호로 상품 상세 정보 조회

제공 데이터

필드명	데이터 형식	설명
sno	number	상품 번호
name	string	상품명
images	array	상품 이미지 목록
kind	string	상품 이미지 종류
sortNo	number	상품 이미지 순번
url	string	상품 이미지 url
status	array	상품 상태
sellFlag	string	판매 상태 - Y : 판매중 - N : 판매 중지
soldOutFlag	string	품절 상태 - Y : 판매중 - N : 판매 중지
options	array	상품 옵션
sno	number	상품 옵션 번호
option1	array	옵션 1
name	string	옵션 제목
value	string	옵션 값
option2	array	옵션 2
option3	array	옵션 3
option4	array	옵션 4
option5	array	옵션 5
originPrice	number	상품 옵션 가격
discountAmount	number	타임세일 할인 가격
stockCount	number	옵션 재고 수
memo	string	옵션 메모
textOptions	array	텍스트 상품 옵션
name	string	옵션 제목
price	number	옵션 가격
requiredFlag	string	옵션 필수 여부 - Y : 사용 - N : 미사용
addGoods	array	추가 상품
title	string	추가 상품 제목
requiredFlag	string	추가 상품 필수 여부 - Y : 필수 - N : 미필수
items	array	추가 상품 정보
sno	number	추가 상품 번호
name	string	추가 상품 명
price	number	추가 상품 가격
registerDateTime	string	등록 일시

사용 예시

<script defer>
    var 변수명_SDK = GodomallSDK.init('systemKey');
    변수명_SDK.getGoods(
        {
            goodsNo: 1000
        },
        function(err, res) {
            if (res) {
                // 필요한 코드 작성
            }
        }
    });
</script>