Front API SDK 가이드

  • 카페24 API를 개발사에서 편리하게 사용하기 위해 Front API 호출 기능을 포함하는 SDK를 제공하고 있습니다.
  • SDK를 이용하시면 보다 편리하고 문제 발생의 원인을 사전에 예방하면서 App을 제작할 수 있습니다.
  • SDK는 반드시 쇼핑몰에 App이 설치된 경우에만 동작합니다. 임의의 스크립트를 통한 사용은 불가능합니다.

SDK 사용 형식

1. CAFE24API.init(appKey)

  • CAFE24API SDK를 초기화합니다. SDK를 사용하기 전에 호출해야합니다.
사용형식

CAFE24API.init(String appKey);

- 파라미터 : appKey (개발자센터에서 생성한 APP의 App Key (=Client id))


올바른 예시

CAFE24API.init('AMj8UZhBC9zsyTlFGI6PzC');

2. CAFE24API.MALL_ID

  • API가 호출되는 쇼핑몰 아이디를 반환합니다.
사용형식

CAFE24API.MALL_ID;


올바른 예시

CAFE24API.MALL_ID;

3. CAFE24API.SHOP_NO

  • 멀티쇼핑몰 번호를 반환합니다.
사용형식

CAFE24API.SHOP_NO;


올바른 예시

CAFE24API.SHOP_NO;

4. CAFE24API.getMemberID(callback)

  • 현재 접속중인 회원 아이디를 반환합니다.
사용형식

CAFE24API.getMemberID(Function callback);


- 파라미터 : callback (회원아이디를 반환할 콜백 함수)
올바른 예시

CAFE24API.getMemberID(function(memberID){
   console.log(memberID);
});

5. CAFE24API.get(url, callback)

  • 호출한 API의 조회된 결과를 반환합니다.
사용형식

CAFE24API.get(String url, Function callback);

- 파라미터 : url (request URL)

- 파라미터 : callback (처리후 호출할 콜백 함수)


올바른 예시

CAFE24API.get('/api/v2/products/10', function(err, res){
   if (err) {
      // 오류 발생시 Error 개체입니다.
      // name, message 속성을 확인할 수 있습니다.
      // res 개체를 통해 상세한 오류메세지 확인이 가능합니다.

   } else {
      // res 개체를 통해 응답 메세지를 확인할 수 있습니다.
   }
});


결과 예시

// 성공시 응답 메세지입니다.
{
   "product": {
   "shop_no": 1,
   "product_no": 10,
   .......
}
}

// 실패시 응답 메세지입니다.
{
   "error": {
   "code": 404,
   "message": "해당 Entity의 ID가 유효하지 않습니다."
}
}

6. CAFE24API.post(url, params, callback)

  • 호출한 API의 등록된 결과를 반환합니다.
사용형식

CAFE24API.post(String url, Object params, Function callback);

- 파라미터 : url (request URL)

- 파라미터 : params (처리할 데이터를 key/value로 전달합니다. / endpoint별 사용가능한 parameters가 다르므로 API 문서를 통해 확인합니다.)

- 파라미터 : callback (처리후 호출할 콜백 함수)


올바른 예시

var params = {
   "request": {
      "duplicated_item_check": "T",
      "product_no": 950,
      "basket_type": "A0000",
      "shipping_type": "A",
      "prefaid_shipping_fee": "P",
      "variants": [
         {
            "quantity": 1,
            "variants_code": "P0000BJU000H"
         }
      ]
   }

}
CAFE24API.post( '/api/v2/cart', params, function(err, res){
   if (err) {
      // 오류 발생시 Error 개체입니다.
      // name, message 속성을 확인할 수 있습니다.
      // res 개체를 통해 상세한 오류메세지 확인이 가능합니다.

   } else {
      // res 개체를 통해 응답 메세지를 확인할 수 있습니다.
   }
});


결과 예시

// 성공시 응답 메세지입니다.
{
   "cart": [

      "product_no": 950,
      "basket_type": "A0000",
      ......
   ]
}

// 실패시 응답 메세지입니다.
{
   "error": {
      "code": 422,
      "message": "장바구니 담기가 실패하였습니다.",
      "more_info": {
         .......
      }
   }
}

사용방법

- 사용방법 (예제)

// 사용할 앱의 App Key를 설정해 주세요.
CAFE24API.init( 'AMj8UZhBC9zsyTlFGI6PzC');

// 몰아이디
CAFE24API.MALL_ID;

// GET
CAFE24API.get( '/api/v2/products/10', function(err, res){
   console.log(res);
});

// POST
var data = {
   "request": {
      "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
      "src": "https://js-aplenty.com/bar.js",
      "display_location": "product_detail"
   }
};
CAFE24API.post( '/api/v2/scripttags', data, function(err, res){
   console.log(res);
});