API
ブランド画像をアップロードする
ブランド画像を 1 つアップロードしてそれまでの画像を置き換え、ブランドを返します。本文は JSON ではなく画像そのものです。
PUT/branding/images/{variant}
実際の呼び出しをワークスペースに対して実行します。
PUT /branding/images/{variant}
ブランド画像を 1 つアップロードしてそれまでの画像を置き換え、ブランドを返します。本文は JSON ではなく画像そのものです。
4 つの画像
| variant | 内容 | 形式 | 保存形式 |
|---|---|---|---|
| mark | 正方形のアイコン | SVG, PNG, JPEG, WebP | WebP、最大 512 × 512 |
| wordmark | ロゴ | SVG, PNG, JPEG, WebP | WebP、最大 1024 × 256 |
| wordmark-dark | ダークモード用ロゴ | SVG, PNG, JPEG, WebP | WebP、最大 1024 × 256 |
| login-background | ログインページの背後の写真 | PNG, JPEG, WebP, GIF | WebP、最大 2560 × 1600 |
バイト列を、その形式を Content-Type に指定して送信します。最大 5 MB まで受け付けます。SVG は画像に変換され、アニメーション画像は最初のフレームが使われます。
例
settings:write と、アドレスやドメインの制限がないキーが必要です。
curl -X PUT "$OE/branding/images/login-background" -H "$AUTH" \ -H "Content-Type: image/jpeg" --data-binary @lobby.jpg{ "object": "branding", "editable": true, "images": { "mark": "https://cdn-prod.openemail.uk/workspaces/icons/0199a1c2-7d4e-7a31-9b52-3c8e1f0a6d24.webp", "wordmark": "https://cdn-prod.openemail.uk/workspaces/wordmarks/0199a1c2-8b10-7e45-a2f1-6d9c3b7e0f58.webp", "wordmarkDark": null, "loginBackground": "https://cdn-prod.openemail.uk/workspaces/login-backgrounds/0199a1c3-0f2e-7c61-8d4a-5b1e9f7a2c36.webp" }, "fonts": { "primary": "inter", "secondary": "georgia" }, "loginBackground": { "kind": "image", "preset": "dusk", "color": null }}ログイン画面の写真をアップロードすると、ログインページもその写真に切り替わります。
そのバリアントが受け付けない形式の画像や読み取れない画像は 422 invalid_image を返します。画像サービスが混み合っていると 503 image_busy、保存に失敗すると 502 image_not_stored を返すので、やり直してください。
