メインコンテンツへスキップ
GET
curl

概要

APIキーから特定されるアプリケーションのホワイトラベルブランディングを返します。これは、認証フローでエンドユーザーに表示されるものと同じブランディングです。レスポンスには、カラー、フォント、角丸の半径、ロゴのURL、UI/UXのオプションが含まれます。

使用する場面

  • 現在のテーマの読み取り: 有効なカラーパレット、フォント、ロゴを表示または編集する前に取得します。
  • ブランディングの同期: Diditのブランディングを自社の管理画面に反映します。

注意事項

  • アプリケーションはAPIキーから特定されるため、パスパラメーターやクエリパラメーターはありません。
  • logo_square、logo_rectangular、logo_rectangular_dark、favicon、font_urlは読み取り専用です。ロゴはブランディングの更新で画像をアップロードして設定します。
  • logo_rectangular_darkはダークモード用の横長ロゴで、暗い背景上に表示されます。 ダークモード用のロゴが設定されていない場合、またはお使いのアカウントで横長ロゴが表示されない場合はnullになります。
  • カスタムドメインとホワイトラベルメールはこのレスポンスに含まれません。これらは引き続きBusiness Consoleで管理します。

権限

APIキーには、アプリケーションのカスタマイズ設定を読み取る権限が必要です。

関連項目

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

レスポンス

アプリケーションの現在のブランディングのカスタマイズ。

アプリケーションのホワイトラベルブランディング:色、フォント、角の丸み、ロゴURL、UI/UXオプション。ロゴURLは読み取り専用です(画像をアップロードして設定します)。カスタムドメインとホワイトラベルメールは含まれません。

color_primary
string
color_secondary
string
color_background
string
color_panel
string
color_panel_10
string
color_on_panel_1
string
color_on_panel_2
string
color_on_background
string
color_button_1
string
color_button_2
string
color_button_text_1
string
color_button_text_2
string
color_pill_text
string
border_radius_panel
integer
border_radius_buttons
integer
font_family
string
font_weight
string
font_url
string | null

読み取り専用。選択したフォントファミリーに対応するGoogle FontsスタイルシートのURLです。

logo_square
string | null

読み取り専用の正方形ロゴURLです。image_squareでアップロードします。

logo_rectangular
string | null

読み取り専用の横長ロゴURLです。image_rectangularでアップロードします。

logo_rectangular_dark
string<uri> | null

読み取り専用。ダークモード用の横長ロゴの一時的な署名付きURLで、暗い背景上に表示されます。ダークロゴが設定されていない場合、またはお客様のアカウントで横長ロゴが表示されない場合はnullです。image_rectangular_darkでアップロードしてください。

favicon
string | null

読み取り専用のファビコンURLです。image_faviconでアップロードします。

app_public_name
string | null
privacy_policy_url
string | null
skip_welcome_screen
boolean
disable_login_with_didit
boolean
hide_progress_bar
boolean
callback_seconds
integer
最終更新日 2026年11月1日