開発者ドキュメント

API・Webhookの使い方、FAQをまとめています

API Documentation

SupacastのAPIを使用すると、商品の管理や注文情報の取得をプログラムから実行できます。

認証

すべてのAPIリクエストには、Authorizationヘッダーが必要です。

Authorization: Bearer yk_live_xxxxxxxxxxxxxxxx

APIキーは、配信者ダッシュボードの「設定」ページから生成できます。

エンドポイント

POST/api/v1/products

商品を作成します

{
  "name": "限定グッズ",
  "price": 2000,
  "description": "数量限定の特別グッズです",
  "image_url": "https://example.com/goods.jpg"
}

PATCH/api/v1/products/:id

商品を更新します（すべてのフィールドは省略可能）

{
  "name": "新しい商品名",
  "price": 1500,
  "is_active": false
}

DELETE/api/v1/products/:id

商品を削除します

GET/api/v1/orders

注文情報を取得します

クエリパラメータ:

• limit - 取得件数（デフォルト: 50, 最大: 100）
• offset - オフセット（デフォルト: 0）
• product_id - 特定の商品のみ取得

使用例

cURL

curl -X POST https://your-domain.com/api/v1/products \
  -H "Authorization: Bearer yk_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"name":"限定グッズ","price":2000,"image_url":"https://..."}'

JavaScript (fetch)

const response = await fetch('/api/v1/products', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer yk_live_xxxxxxxx',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '限定グッズ',
    price: 2000,
    image_url: 'https://example.com/goods.jpg'
  })
});

const data = await response.json();