screenRIG
サインイン開始する

API リファレンス

ウェブサイトのデモ API

ウェブサイトのデモリクエストと予約

HTTP リファレンス。 バックエンド契約から生成。以下のエンドポイントを参照するか、OpenAPI をダウンロードしてください。

OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要

このグループには 7 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。

大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。

ウェブサイトのデモリクエストと予約

POST/website/demo-requests

ウェブサイトデモリクエストを送信

同一オリジンの匿名ウェブサイト受付。リクエストと独立した配信ジョブを分類前に保存します。Idempotency-Keyは独立したランダムなプライベートリトライUUIDで、ブラウザメモリにのみ保持されます。公開flow_idではありません。マッチするリトライは同じHttpOnly screenrig_demoクッキーを設定し、再送信なしで保存済みリクエストを返します。

リクエストとレスポンスはペイロードログから除外されます。国はタイムゾーンを選択しません。プロジェクトやダッシュボードのログインは作成されません。

認証
なし
リクエスト本文
DemoRequestInput
操作ID
submitWebsiteDemoRequest

パラメーター

名前送信する必須？説明
オリジンヘッダー必須同一オリジンのブラウザーリクエスト。設定されたステージオリジンはステージで受け入れられます。
Idempotency-Keyヘッダー必須
fクエリオプション秘密でないファネル試行ID、bodyのflow_idと同じ。
srcクエリオプション許可リストにあるソースで、本文のソースと同一です。

リクエスト本文フィールド

フィールド説明
email（必須、文字列）maxLength：254 フォーマット：「email」
country（必須、文字列）ISO 3166-1国コード。タイムゾーンとは別に保持。パターン："^[A-Z]{2}$"。
screen_range（必須、文字列）許可："1_10"、"11_50"、"51_250"、"251_plus"、"unknown"
組織（必須、文字列）許可されている値: "small_mid"、"large_corporation"、"agency_network"。
budget（必須、文字列）自己申告の年間サイネージ予算（USD）。許可される値：「under_2995」、「2995_19994」、「19995_plus」、「unknown」
タイムゾーン（必須、文字列）IANAタイムゾーン。ブラウザ検出が利用できない場合は空です。スケジューリングには明示的なタイムゾーンが必要です。maxLength：100
source（必須、DemoSource）許可："home_hero"、"home_paid_plans"、"pricing_plus"、"pricing_education"、"pricing_premium"、"pricing_enterprise"、"resellers"、"direct"
flow_id（必須、文字列）ランダムな非秘密の分析試行 ID です。認可には使用しません。パターン: "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie-jar cookies.txt --header 'Origin: https://screenrig.ai' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/website/demo-requests'

レスポンス

ステータス意味本文とヘッダー
201永続的に保存されたリクエスト。プライベートデモセッションのクッキーを設定。DemoResult（application/json）
200保存されたリクエストの冪等な再生に一致します。DemoResult（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/website/demo-request

ウェブサイトデモリクエストを取得

Cookie バインドされた保存リクエスト。リクエスト ID または公開フロー ID はアクセスを許可しません。No-store。

認証
demoSession
リクエスト本文
なし
操作ID
getWebsiteDemoRequest
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/website/demo-request'

レスポンス

ステータス意味本文とヘッダー
200デモリクエストと予約状態を保存。DemoResult（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/website/demo-calendar

ウェブサイトデモカレンダーを取得

このブラウザの確定予約のプライベートカレンダーダウンロード。保存されたイベントを再確認します。リクエストIDや公開フローIDはアクセスを許可しません。ノーストア。

認証
demoSession
リクエスト本文
なし
操作ID
getWebsiteDemoCalendar
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/website/demo-calendar'

レスポンス

ステータス意味本文とヘッダー
200安定したIDと確定した時間を持つインポート可能なカレンダーイベント。string (text/calendar)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/website/demo-slots

ウェブサイトデモスロットを取得

訪問者の編集可能なIANAタイムゾーンで、可能な限り日付と時間を変えて最大4つの実際に利用可能な30分スロット。プライベートスロットIDはJSON本文で返され、URLクエリには送信されません。カレンダー未設定または合理的なタイムゾーン重複がない場合は空リストを返します。

認証
demoSession
リクエスト本文
なし
操作ID
getWebsiteDemoSlots

パラメーター

名前送信する必須？説明
タイムゾーンクエリ必須
更新クエリオプション前のクッキーに紐づくバッチの代替案を提供します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/website/demo-slots?timezone=TIMEZONE'

レスポンス

ステータス意味本文とヘッダー
200実際の利用可能スロットまたは空リスト。DemoSlots（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/website/demo-bookings

ウェブサイトデモを予約

クッキーに紐づくスロットを再確認し、ホストバッファセルを原子操作で予約し、設定されたローカルまたはGoogleカレンダーに安定したイベントを作成します。確認には実際のイベントと保存された予約が必要です。あいまいなプロバイダ障害は耐久的な調整のため保留のままで、二重イベントや誤予約ページは発生しません。

認証
demoSession
リクエスト本文
object
操作ID
bookWebsiteDemo

パラメーター

名前送信する必須？説明
オリジンヘッダー必須同一オリジンのブラウザーリクエスト。設定されたステージオリジンはステージで受け入れられます。
fクエリオプション秘密でないファネル試行ID、保存されたflow_idと同じ。
srcクエリオプション許可リストに登録されたソースを保存。

リクエスト本文フィールド

フィールド説明
slot_id（必須、文字列）既に確認済みのクッキーに紐づく予約の再生のみ空にできます。パターン: "^([A-Za-z0-9_-]{20,128})?$"
タイムゾーン（必須、文字列）maxLength：100
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Origin: https://screenrig.ai' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/website/demo-bookings'

レスポンス

ステータス意味本文とヘッダー
201カレンダーイベントと予約が確認され保存されました。DemoResult（application/json）
200すでに予約の再生が確認されています。DemoResult（application/json）
202予約はプロバイダーの照合待ちです。確定予約の分析から除外されます。DemoResult（application/json）
409

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/website/demo-review

ウェブサイトデモレビューを依頼

既存のオンデマンドリクエストにチームレビューのフラグを立てます。追加のアンケートは不要です。遅延分類者の返信はこの選択を覆せません。

認証
demoSession
リクエスト本文
object
操作ID
requestWebsiteDemoReview

パラメーター

名前送信する必須？説明
オリジンヘッダー必須同一オリジンのブラウザーリクエスト。設定されたステージオリジンはステージで受け入れられます。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Origin: https://screenrig.ai' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/website/demo-review'

レスポンス

ステータス意味本文とヘッダー
200レビュー要求付きの現在保存されたリクエスト。DemoResult（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/website/demo-session

Exchange ウェブサイトデモ招待

メールで送られた7日間の予約招待をブラウザ専用のHttpOnlyデモセッションに交換します。ウェブサイトはリクエスト前に招待フラグメントを削除し、トークンはこのプライベートなPOST本文でのみ送信され、URL、リダイレクト、分析マーカー、ログには決して含まれません。複数のブラウザセッションが同じ招待にアクセス可能です。

認証
なし
リクエスト本文
object
操作ID
exchangeWebsiteDemoInvitation

パラメーター

名前送信する必須？説明
オリジンヘッダー必須同一オリジンのブラウザーリクエスト。設定されたステージオリジンはステージで受け入れられます。

リクエスト本文フィールド

フィールド説明
トークン（必須、文字列）パターン: "^[A-Za-z0-9_-]{20,128}$"
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie-jar cookies.txt --header 'Origin: https://screenrig.ai' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/website/demo-session'

レスポンス

ステータス意味本文とヘッダー
200Cookie 設定済み保存リクエストが返されました。DemoResult（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)