Front API SDKガイド

  • cafe24APIを開発元で便利に使用するため、フロントAPI呼び出し機能を含むSDKを提供しています。
  • SDKを利用すると、より便利で問題発生の原因を事前に予防し、Appを制作することができます。
  • SDKは、必ずネットショップにAppが設置された場合にのみ動作します。 任意のスクリプトではご利用いただけません。

SDK使用形式

1. CAFE24API.init(appKey)

  • CAFE24API SDKを初期化します。 SDKを使用する前に呼び出ししてください。
使用形式

CAFE24API.init(String appKey);

- パラメータ : appKey (cafe24 デベロッパーで生成したAPPのApp Key (=Client id))


正しい例示

CAFE24API.init('AMj8UZhBC9zsyTlFGI6PzC');

2. CAFE24API.MALL_ID

  • APIが呼び出されるネットショップIDを返還します。
使用形式

CAFE24API.MALL_ID;


正しい例示

CAFE24API.MALL_ID;

3. 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が有効ではありません。"
   }
}

4. 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');

// MALL_ID
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);
});