CAFE24 APIをはじめる

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

API概要

項目	説明
Base URL	https://{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 Token	2時間	API呼び出し時の認証
Refresh Token	14日	Access Tokenの再発行

レート制限（Rate Limit）

API呼び出しには、総量制限（クォータ）と瞬間的な流量制限が同時に適用されます。 別途設定がない限り、以下の値が既定で適用されます。

区分	制限値
10分あたりの呼び出し回数	3,000回
10分あたりの呼び出し時間	600秒

制限を超過すると 429 Too Many Requests レスポンスが返されます。 詳細はAPIクォータガイドを参照してください。

エラーハンドリング

HTTPステータスコード

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

エラーレスポンス形式

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

次のステップ

• Admin APIドキュメント - Admin APIリファレンス
• OAuth認証ガイド - 認証の詳細ガイド
• エラーコード一覧 - エラーコードの全リスト