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	회원 프로필

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>

회원 프로필

제공 데이터

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

사용 예시

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

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