REST API概要

Screenzzie REST APIを使用すると、デジタルサイネージスクリーン、プレイリスト、メディア、スケジュールをプログラムで管理できます。連携、自動化、カスタムアプリケーションに最適です。

ベースURL

すべてのAPIエンドポイントは以下で利用可能です：

https://www.screenzzie.com/api/v1

認証

APIはAPIキーを使用したBearerトークン認証を使用します。AuthorizationヘッダーにAPIキーを含めてください：

curl -X GET "https://www.screenzzie.com/api/v1/screens" \
  -H "Authorization: Bearer sk_live_your_api_key_here" \
  -H "Content-Type: application/json"

APIキーの取得

Screenzzieダッシュボードで設定 > APIキーに移動
APIキーを作成をクリック
わかりやすい名前を選択し、権限を選択
キーをすぐにコピー（一度しか表示されません！）

APIキーを安全に保管してください！クライアント側コードや公開リポジトリに公開しないでください。

APIキースコープ

APIキーを作成する際、3つの権限レベルから選択できます：

スコープ	権限
Read	スクリーン、プレイリスト、メディア、スケジュールの表示
Write	Read + リソースの作成、更新、削除
Admin	APIキー管理を含む完全なアクセス

レート制限

APIリクエストはサブスクリプションプランに基づいてレート制限されています：

プラン	1日あたりのリクエスト数
Business	1,000
Growth	100,000
Enterprise	無制限

レート制限ヘッダーはすべてのレスポンスに含まれます：

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1704067200

レスポンス形式

すべてのレスポンスは一貫した構造を持つJSON形式で返されます：

成功レスポンス

{
  "success": true,
  "data": {
    // リソースデータ
  }
}

ページネーションレスポンス

{
  "success": true,
  "data": {
    "items": [...],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 100,
      "totalPages": 5,
      "hasMore": true
    }
  }
}

エラーレスポンス

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Name is required",
    "details": { ... }
  }
}

エラーコード

コード	説明
`UNAUTHORIZED`	無効または欠落したAPIキー
`FORBIDDEN`	権限不足
`NOT_FOUND`	リソースが見つからない
`VALIDATION_ERROR`	無効なリクエストパラメータ
`RATE_LIMIT_EXCEEDED`	リクエストが多すぎる
`FEATURE_NOT_AVAILABLE`	上位プランが必要な機能
`INTERNAL_ERROR`	サーバーエラー

利用可能なエンドポイント

APIは以下のリソースを提供します：

Screens - デジタルサイネージスクリーンの管理
Playlists - プレイリストの作成と管理
Media - メディアファイルへのアクセスと登録
Schedules - コンテンツのスケジュール（Growthプラン）

次のステップ

APIエンドポイントリファレンスを確認
ダッシュボードで最初のAPIキーを作成

API概要

docs.apiCtaBanner.title