MostlyRender

認証

署名付きレンダー URL を除く、すべての REST リクエストは、Bearer トークンとして送信される API キー で認証されます。

# API キー

アプリ内の Settings → API keys でキーを作成します。2 種類あります:

プレフィックス 用途
mr_live_… 本番環境 — プランのクォータと請求に対してカウントされます。
mr_test_… テスト。

キーは作成時に 1 回だけ 表示されます — 安全な場所に保管してください。サーバー側には SHA-256 ハッシュのみが保持されるため、失われたキーは復旧できず、失効と置換のみが可能です。

# キーの送信

すべてのリクエストに Authorization ヘッダーを追加します:

http
Authorization: Bearer mr_live_xxxxxxxxxxxxxxxxxxxxxxxx
bash
curl https://api.mostlyrender.com/v1/account \
  -H "Authorization: Bearer mr_live_…"

GET /v1/account はキーを検証する最も簡単な方法です — 接続されたアカウントを返すか、キーが見つからない、無効、または失効している場合は 401 を返します。

json
{ "plan": "pro", "email": "you@example.com", "display_name": "Ada Lovelace" }

# ベース URL

text
https://api.mostlyrender.com

カスタム API ドメインが接続されるまで、ライブ ホストは https://mostly-render-api.web.app です。SDK は base_url オーバーライドを受け入れます。

# キーを安全に保つ

  • クライアント側コードにキーを含めないでください。ブラウザ / <img> 用には、代わりに 署名付きレンダー URL を生成してください — キーは不要です。
  • 新しいキーを作成して古いキーを失効させることでローテーションします;失効は即座に反映されます。