サイトのブランド設定 API

サイトのドメインに基づいて公開ブランド表示設定を取得する方法を、連携システム向けに説明します。

一つのバックエンドサービスが異なるブランドのサイトを提供する場合、ログイン前のページにもサイト名、画像、リンクの情報が必要です。連携システムは現在のサイトのドメインから GET /api/branding/ を呼び出し、そのサイトの公開表示設定を取得できます。この読み取りエンドポイントにログインは不要です。

設定の取得と適用

1. 対象サイトを提供するドメインから GET /api/branding/ を送信します。ブランドはリクエストの Host で決まり、ユーザー、組織 ID、クエリパラメーターでは選択しません。

2. レスポンスから必要な表示項目を読み取ります。たとえば、サイト名には siteName、フルサイズのロゴには logoFullUrl、メインカラーには primaryColor を使用します。

3. 項目が null の場合は、対応する要素を非表示にしてください。他のブランドのデフォルト素材を代わりに設定しないでください。ドメイン固有の設定がない場合、サービスはまずシステムのデフォルトブランドを使用します。デフォルトブランドもない場合、すべての項目が null になります。

連携システムがリバースプロキシを経由する場合は、API に転送される Host が、表示したいブランドのサイトのドメインのままであることを確認してください。共通の API ドメインから直接呼び出すと、その API ドメインに対応するブランド、またはシステムのデフォルトブランドが返されます。

レスポンス項目

HTTP 200 では、項目名が camelCase の JSON オブジェクトを返します。

用途	項目
テキスト	siteName、assistantName、supportEmail、poweredByText
画像 URL	faviconUrl、logoMarkUrl、logoFullUrl、logoAnimatedUrl、assistantIconUrl、ogImageUrl
色	primaryColor、splashBackgroundColor、splashTextColor、progressBarColor
リンク	docsUrl、termsUrl、privacyUrl、loginRedirectUrl

すべての項目が null になる可能性があります。画像項目には表示に使用できる URL が入ります。連携システムではレスポンスの値をそのまま使用し、メディアパスを組み立てないでください。