Получить бренд
Бренд рабочего пространства: ссылка на каждое изображение бренда, основной и дополнительный шрифты и фон страницы входа.
Выполняет настоящий запрос в вашем рабочем пространстве.
GET /branding
Бренд рабочего пространства: ссылка на каждое изображение бренда, основной и дополнительный шрифты и фон страницы входа.
Что такое бренд
export OE=https://api.openemail.ukexport AUTH="Authorization: Bearer $OPENEMAIL_API_KEY"Бренд задаётся на странице «Внешний вид» рабочего пространства: четыре изображения, два шрифта и фон страницы входа. У личного пространства его нет.
mark, квадратный значок, показывается в переключателе рабочих пространств, а после того как задан логотип, и как значок адреса веб-приложения.wordmark, логотип, показывается вверху боковой панели. Именно он брендирует адрес веб-приложения и, на платном тарифе, письма, которые OpenEmail отправляет от имени рабочего пространства: в них логотип стоит вверху и внизу, а вместо OpenEmail указано название рабочего пространства. Без логотипа и то и другое выглядит как OpenEmail.wordmarkDark, логотип для тёмной темы, заменяет логотип, когда приложение показано в тёмной теме.loginBackground, фотография, лежит под страницей входа на адресе веб-приложения.
Два шрифта действуют в веб-приложении для всех в рабочем пространстве: основной для текста, дополнительный для заголовков страниц, а фон страницы входа показывается на адресе веб-приложения, задан логотип или нет. Каждый шрифт задаётся одним из этих идентификаторов или null для значения по умолчанию: system, arial, helvetica, verdana, tahoma, trebuchet-ms, georgia, times-new-roman, courier-new, dm-sans, inter, roboto, open-sans, lato, montserrat, poppins, nunito, work-sans, source-sans-3, ibm-plex-sans, merriweather, playfair-display, instrument-serif, jetbrains-mono, dm-mono, geist-mono.
Пример
Требуется settings:read.
curl "$OE/branding" -H "$AUTH"{ "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": null }, "fonts": { "primary": "inter", "secondary": "georgia" }, "loginBackground": { "kind": "preset", "preset": "dusk", "color": null }}editable показывает, может ли этот ключ менять бренд. Оно равно false в личном пространстве, для ключа без settings:write и для ключа, ограниченного определёнными адресами или доменами.
loginBackground вида image читается как null, пока фото страницы входа не загружено.