Star API

Star API 開発者ガイド

Star API 付きパートナー向けの外部開発者ガイドです。自社プラットフォームを Star に接続し、ピッチ受信、キャンペーン状況の追跡、フィット付きショートリストの確認、納品アセットの取得、Webhook の受信を行います。見えるデータはパートナーキーのスコープ内のみです。

ベース/api/star/v1

認証Bearer star_live_… / star_test_…

Star を始める ← Star に戻る

認証

すべてのリクエストに、Star API が見積もりに含まれる貴社向けパートナー API キーが必要です。本番キーは star_live_、サンドボックスは star_test_ で始まります。ダッシュボード作成時に一度だけ表示されるので、他の秘密情報と同様に保管してください。

Authorization: Bearer star_live_…

キーが応答をスコープします。自社アカウントに紐づくブリーフ、ショートリスト、クリエイターのみ取得できます。Star は公開ロスター一覧ではありません。

ブリーフとキャンペーンパイプライン

貴社側からキャンペーンブリーフを送信し、Branch B の制作進捗を読み取ります。ステージは次の順です。 RECEIVED → REVIEWED → PITCHED → GREENLIT → PRE_PROD → LIVE → DELIVERED.

POST /briefs

{
  "title": "Summer launch PV",
  "brief": "Music-led campaign for JP + EN audiences…",
  "brand": "Acme",
  "ownerName": "Maya Chen",
  "budgetNote": "Premium",
  "genres": ["J-pop"],
  "formats": ["Music video"],
  "languages": ["Japanese", "English"]
}

GET /briefs · GET /briefs/:id

ブリーフ一覧、または id 指定で取得。パイプライン時刻、daysInStage、遅延フラグ、ショートリスト、納品アセットを含みます。

PATCH /briefs/:id

連携で必要なフィールド（ステージ関連の表示名など）を更新できます。

{ "stage": "PITCHED", "ownerName": "Maya Chen" }

フィット付きクリエイターショートリスト

閲覧可能なクリエイターカタログはありません。ブリーフごとにショートリストが返ります。提案クリエイター、フィット理由（ジャンル、形式、言語、検証済みリーチ）、想定再生帯、席の状態 PROPOSED / ACCEPTED / DECLINED。

POST /briefs/:id/shortlist

ブリーフ条件とアカウントフィルタに合うロスターから席を提案させます。

{ "action": "propose", "limit": 5 }

またはクリエイターを付けて席の決定を自分で設定します。

{
  "creatorId": "clx…",
  "seatStatus": "ACCEPTED",
  "fitNote": "Strong EN anime audience, Live2D ready"
}

GET /briefs/:id/shortlist

このブリーフのフィットカードのみ返します。判定、スコア、一致タグ、理由、想定インプレッション、クリエイター指標。

{
  "shortlist": [{
    "status": "PROPOSED",
    "fit": {
      "verdict": "Strong fit",
      "reasons": ["Genre match: J-pop", "Language match: English"],
      "matched": { "genres": ["J-pop"], "formats": [], "languages": ["English"] }
    },
    "estimatedImpressions": { "min": 80000, "max": 150000 },
    "creator": { "id": "…", "name": "…", "reach": 32000 }
  }]
}

クリエイターと検証済み指標

すでにショートリスト上のクリエイターだけを一覧します。言語、ジャンル、形式、検証済みフォロワー、平均再生、成長、lastCheckedAt を含みます。検索もこのパートナー範囲に限定されます。

GET /creators?q=english
GET /creators/:id

納品アセット

カットやファイナルの準備ができたらブリーフから取得します。DAM や確認キューへ URL を同期できます。

PATCH /briefs/:id
{
  "asset": {
    "kind": "FINAL",
    "label": "Master 1080p",
    "url": "https://…",
    "deliveredAt": "2026-08-15T18:00:00.000Z"
  }
}

Webhook

自社サーバーの HTTPS エンドポイントを登録します。イベント時に署名付きペイロードを POST します。シークレット発行時は X-Star-Signature（sha256=…）を検証してください。

POST /webhooks
{
  "url": "https://your.app/hooks/star",
  "events": ["pitch.sent", "status.changed", "creator.accepted", "asset.ready"]
}

アカウントと設定

パートナーアカウントの参照と、連携用フィルタ（最小フォロワー、プラットフォーム、言語、一時停止除外）の更新。

GET /account
PATCH /account
{
  "config": {
    "minFollowers": 40000,
    "platforms": ["YOUTUBE"],
    "excludePaused": true,
    "languages": ["Japanese", "English"]
  }
}

エクスポート

キャンペーン CSV をダウンロードし、表計算やオフライン同期に使えます。

GET /export/briefs

イベント一覧

brief.created: 新規ブリーフ送信
pitch.sent: パイプラインがピッチ、またはショートリスト提案
status.changed: その他のステージ変更
creator.accepted / creator.declined: クリエイター席の承認または辞退
asset.ready: 納品リンク添付