メインコンテンツまでスキップ

CAFE24 APIをはじめる

CAFE24 APIを使用すると、ショッピングモールの商品、注文、顧客などの各種データをプログラムから管理できます。

API概要​

項目説明
Base URLhttps://{mall_id}.cafe24api.com/api/v2
プロトコルHTTPS（TLS 1.2以上）
認証方式OAuth 2.0
レスポンス形式JSON
文字エンコーディングUTF-8

クイックスタート​

1. アプリ登録​

CAFE24 デベロッパーセンターでアプリを登録し、Client IDとClient Secretを取得します。

2. アクセストークンの発行​

curl -X POST "https://{mall_id}.cafe24api.com/api/v2/oauth/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=authorization_code" \
  -d "code={authorization_code}" \
  -d "redirect_uri={redirect_uri}" \
  -d "client_id={client_id}" \
  -d "client_secret={client_secret}"

3. APIの呼び出し​

curl -X GET "https://{mall_id}.cafe24api.com/api/v2/admin/products" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json"

4. レスポンスの確認​

{
  "products": [
    {
      "product_no": 1,
      "product_name": "サンプル商品",
      "price": "10000.00",
      "created_date": "2024-01-15T09:00:00+09:00"
    }
  ]
}

APIの種類​

Admin API​

ショッピングモール管理者向けAPIです。商品登録、注文管理、顧客管理などの管理機能を提供します。

  • 商品管理（Products）
  • 注文管理（Orders）
  • 顧客管理（Customers）
  • カテゴリ管理（Categories）

Front API​

ショッピングモールのフロントエンド向けAPIです。商品照会、カート、注文などの顧客機能を提供します。

  • 商品照会
  • ショッピングカート
  • 注文／決済

認証（OAuth 2.0）​

CAFE24 APIはOAuth 2.0認証方式を採用しています。

┌─────────┐     1. 認可リクエスト   ┌─────────────┐
│   App   │ ──────────────────▶ │   CAFE24    │
│         │                     │   OAuth     │
│         │ ◀────────────────── │   Server    │
└─────────┘  2. アクセストークン  └─────────────┘
     │
     │ 3. API呼び出し（Bearer Token）
     ▼
┌─────────────┐
│   CAFE24    │
│   API       │
└─────────────┘

トークンの種類​

トークン有効期間用途
Access Token2時間API呼び出し時の認証
Refresh Token14日Access Tokenの再発行

レート制限（Rate Limit）​

API呼び出しには以下の制限があります。

区分制限値
秒間リクエスト数10回
分間リクエスト数300回

レート制限を超過すると 429 Too Many Requests レスポンスが返されます。

エラーハンドリング​

HTTPステータスコード​

コード説明
200成功
201作成完了
400不正なリクエスト
401認証エラー
403アクセス権限なし
404リソースが見つかりません
429レート制限超過
500サーバー内部エラー

エラーレスポンス形式​

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "必須パラメータが不足しています。",
    "more_info": "https://developers.cafe24.com/errors/INVALID_REQUEST"
  }
}

次のステップ​