API リファレンス

PulseSign APIは、コンテンツ・デバイス・スケジュールをプログラムから管理するためのREST APIです。すべてのリクエスト・レスポンスはJSON形式で、HTTPSでの通信が必須です。 The PulseSign API is a REST API for managing content, devices, and schedules programmatically. All requests and responses use JSON, and HTTPS is required.

ベースURLBase URL

https://api.pulse-sign.com/v1

認証Authentication

管理APIへのリクエストには、Bearerトークンを Authorization ヘッダーに付与します。トークンはダッシュボードの設定画面から発行できます。Authenticate admin API requests with a Bearer token in the Authorization header. Issue tokens from the settings screen in your dashboard.

Authorization: Bearer <YOUR_API_TOKEN>
Content-Type: application/json

デバイス（プレイヤー）からのリクエストは、Bearerトークンではなく X-Device-Token ヘッダーで認証します。Device (player) requests authenticate with the X-Device-Token header instead of a Bearer token.

主なエンドポイントCore endpoints

メディアMedia

GET /media          # メディア一覧を取得# list media
POST /media         # アップロード用URLを発行# create an upload URL
DEL /media/{id}     # メディアを削除# delete media

デバイスDevices

GET /devices        # デバイス一覧と稼働状態# list devices & status
POST /devices/pair  # ペアリングコードで登録# pair with a code

プレイリスト & スケジュールPlaylists & schedules

GET /playlists      # プレイリスト一覧# list playlists
POST /schedules     # スケジュールを作成・配信# create & publish a schedule

レスポンス例Example response

{
  "id": "dev_8f2a",
  "name": "Lobby Screen",
  "status": "online",
  "lastSeen": "2026-06-24T08:30:00Z"
}

レート制限Rate limits

APIは1分あたり最大600リクエストまで受け付けます。上限に達した場合は 429 Too Many Requests を返します。The API accepts up to 600 requests per minute. Exceeding the limit returns 429 Too Many Requests.

エラーErrors

エラー時は標準的なHTTPステータスコードと、原因を示すJSONボディを返します。Errors return a standard HTTP status code along with a JSON body describing the cause.

{ "error": "not_found", "message": "Device not found" }

※ 本ページはAPIの概要です。インタラクティブな全リファレンス（OpenAPI/Swagger）は、ダッシュボードの /docs よりご確認いただけます。 Note: This page is an overview. The full interactive reference (OpenAPI/Swagger) is available at /docs in your dashboard.

API リファレンスAPI Reference