How to change branding of Bold BI

Published:

Bold BI provides a RESTful web API for Cloud and Embedded applications that allows other third-party applications to interact with Bold BI programmatically. Users can be able to customize the branding of the Bold BI Application by use of an API. Customizing Bold BI branding includes actions of changing site values.

API will support customizing branding of below items:

OrganizationName
LoginScreenLogo
EmailLogo
FavIcon
ShowCopyrightInformation
ShowPoweredBySyncfusion
Use24HourFormat
DisableUserPreference
DateFormat
TimeZone

SiteUrl and DataLanguage are only available on Embedded BI.

NOTE: Only users who have admin rights to the site or manage site settings permission can update the site settings and make all the applicable changes to the site.

Steps to customize the branding of Bold BI

NOTE: When you sign into the Bold BI, an authentication token is provided that should be attached in the request header (Authorization) for all subsequent API calls to authenticate the requests.

Follow the steps below to apply the customization branding of Bold BI:

Set up and use the Bold BI URL as below:
1. Embed BI: If https:///bi/site/ is your Bold BI Embed site URL, then the API end of this site will be accessed by https://{yourdomain}/bi/api/site/
2. Cloud BI: If https:///bi is your Bold BI cloud site URL, then the API end of this site will be accessed by https://{yourdomain}/bi/api

Add the following endpoint (/v4.0/settings/site) to the site URL and use the request HTTP method PUT in request Postman to update the settings. Set up the URL as shown below:
1. Cloud BI: https://{yourdomain}/bi/api/v4.0/settings/site
2. Embed BI: https://{yourdomain}/bi/api/site/<site_identifier>/v4.0/settings/site

Add authorization header with a generated access token and content-type header as application/json then prepare request body with the desired branding using key and value items as shown in the following example:

[
 {
   "Key": "OrganizationName,”
   "Value": "Bold BI"
 },
 {
   "Key": "LoginScreenLogo,”
   "Value": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzdmcgd2lkdGg9IjQwcHgiIGhlaWdodD0iNDBweCIgdmlld0JveD0iMCAwIDQwIDQwIiB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiPg0KICAgIDwhLS0gR2VuZXJhdG9yOiBTa2V0Y2ggNTMuMiAoNzI2NDMpIC0gaHR0cHM6Ly9za2V0Y2hhcHAuY29tIC0tPg0KICAgIDx0aXRsZT5IZWFkZXI8L3RpdGxlPg0KICAgIDxkZXNjPkNyZWF0ZWQgd2l0aCBTa2V0Y2guPC9kZXNjPg0KICAgIDxnIGlkPSJIZWFkZXIiIHN0cm9rZT0ibm9uZSIgc3Ryb2tlLXdpZHRoPSIxIiBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPg0KICAgICAgICA8ZyBpZD0iR3JvdXAiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDQuMDAwMDAwLCA0LjAwMDAwMCkiIGZpbGw9IiNGRjQ4MDAiIGZpbGwtcnVsZT0ibm9uemVybyI+DQogICAgICAgICAgICA8cGF0aCBkPSJNOC4xNjY3NjA1NiwwIEwxNi4wNTQwODQ1LDAgQzE4LjIzMDk4NTksMCAxOS45OTc3NDY1LDEuNzkyIDE5Ljk5Nzc0NjUsNCBMMTkuOTk3NzQ2NSw4IEMxOS45OTc3NDY1LDEwLjIwOCAxOC4yMzA5ODU5LDEyIDE2LjA1NDA4NDUsMTIgTDAuMjc5NDM2NjIsMTIgTDAuMjc5NDM2NjIsOCBDMC4yNzk0MzY2MiwzLjU4NCAzLjgwODQ1MDcsMCA4LjE2Njc2MDU2LDAgWiIgaWQ9IlBhdGgiPjwvcGF0aD4NCiAgICAgICAgICAgIDxwYXRoIGQ9Ik04LjE2Njc2MDU2LDAgTDE2LjA1NDA4NDUsMCBDMTguMjMwOTg1OSwwIDE5Ljk5Nzc0NjUsMS43OTIgMTkuOTk3NzQ2NSw0IEwxOS45OTc3NDY1LDggQzE5Ljk5Nzc0NjUsMTAuMjA4IDE4LjIzMDk4NTksMTIgMTYuMDU0MDg0NSwxMiBMMC4yNzk0MzY2MiwxMiBMMC4yNzk0MzY2Miw4IEMwLjI3OTQzNjYyLDMuNTg0IDMuODA4NDUwNywwIDguMTY2NzYwNTYsMCBaIiBpZD0iUGF0aCI+PC9wYXRoPg0KICAgICAgICAgICAgPHBhdGggZD0iTTAuMjc5NDM2NjIsMTYgTDE2LjA1NDA4NDUsMTYgQzE4LjIzMDk4NTksMTYgMTkuOTk3NzQ2NSwxNy43OTIgMTkuOTk3NzQ2NSwyMCBMMTkuOTk3NzQ2NSwyOCBDMTkuOTk3NzQ2NSwzMC4yMDggMTguMjMwOTg1OSwzMiAxNi4wNTQwODQ1LDMyIEw4LjE2Njc2MDU2LDMyIEMzLjgxMjk1Nzc1LDMyIDAuMjc5NDM2NjIsMjguNDE2IDAuMjc5NDM2NjIsMjQgQzAuMjc5NDM2NjIsMjQgMC4yNzk0MzY2MiwxNiAwLjI3OTQzNjYyLDE2IFoiIGlkPSJQYXRoIj48L3BhdGg+DQogICAgICAgICAgICA8cGF0aCBkPSJNMjcuODg1MDcwNCwxNiBMMzEuODI4NzMyNCwxNiBMMzEuODI4NzMyNCwyNCBDMzEuODI4NzMyNCwyOC40MTYgMjguMjk1MjExMywzMiAyMy45NDE0MDg1LDMyIEwyMy45NDE0MDg1LDMyIEwyMy45NDE0MDg1LDIwIEMyMy45NDE0MDg1LDE3Ljc5MiAyNS43MDM2NjIsMTYgMjcuODg1MDcwNCwxNiBaIiBpZD0iUGF0aCI+PC9wYXRoPg0KICAgICAgICAgICAgPHBhdGggZD0iTTIzLjk0MTQwODUsMCBMMjMuOTQxNDA4NSwwIEMyOC4yOTUyMTEzLDAgMzEuODI4NzMyNCwzLjU4NCAzMS44Mjg3MzI0LDggTDMxLjgyODczMjQsMTIgTDI3Ljg4NTA3MDQsMTIgQzI1LjcwODE2OSwxMiAyMy45NDE0MDg1LDEwLjIwOCAyMy45NDE0MDg1LDggTDIzLjk0MTQwODUsMCBaIiBpZD0iUGF0aCI+PC9wYXRoPg0KICAgICAgICA8L2c+DQogICAgPC9nPg0KPC9zdmc+",
   "FileFormat": "png"
 }	
]

Request Body Content:

Key	Value	File Format	Example
OrganizationName	String	N/A	[ { “Key”: "OrganizationName”, “Value”: “Bold BI” } ]
LoginScreenLogo	Base64EncodedString	Svg/png/ jpg/ jpeg	[ { “Key”: “LoginScreenLogo”, “Value”: “”, //include encoded string here “FileFormat”: “jpeg” } ]
EmailLogo	Base64EncodedString	Svg/png/ jpg/ jpeg	[ { “Key”: “EmailLogo”, “Value”: “”, //include encoded string here “FileFormat”: “png” } ]
FavIcon	Base64EncodedString	Svg/png/ jpg/ jpeg	[ { “Key”: “FavIcon”, “Value”: “”, //include encoded string here “FileFormat”: " jpg " } ]
ShowCopyrightInformation	boolean	N/A	[ { “Key”: “ShowCopyrightInformation”, “Value”: “true” } ]
ShowPoweredBySyncfusion	boolean	N/A	[ { “Key”: “ShowPoweredBySyncfusion”, “Value”: “false” } ]
Use24HourFormat	boolean	N/A	[ { “Key”: “Use24HourFormat”, “Value”: “false” } ]
DisableUserPreference	boolean	N/A	[ { “Key”: “DisableUserPreference”, “Value”: “true” } ]
DateFormat	MM/dd/yyyy dd/MM/yyyy d MMM yyyy MMM d yyyy	N/A	[ { “Key”: “DateFormat”, “Value”: " MM/dd/yyyy" } ]
TimeZone	String	N/A	[ { “Key”: “TimeZone”, “Value”: “GMT-12:00” } ]
SiteUrl	String	N/A	[ { “Key”: " SiteUrl", “Value”: “” //Include site URL here } ]
DataLanguage	String	N/A	[ { “Key”: “DataLanguage”, “Value”: “en-us” } ]

Successful status code of 200 confirms successful settings update with a status message as shown below:

{
 "ApiStatus": true,
 "Status": true,
 "StatusMessage": "Site settings have been updated successfully"
}

Related links

Was this article useful?

Dislike

Written by Enos Otieno Juma

Updated:

Comments (0)

How to change branding of Bold BI

Steps to customize the branding of Bold BI

Access denied