API Endpoints

Display modes

You can change the default colors used in the application by setting de primary and secondary colors via URL parameters.

You can customize the color for the main background by setting the "backgroundColor" attribute via URL parameters.

📘

Color Value in URL Encoding

Beware that color values have to be passed using the hexadecimal code I.e. “#FF00BB”, but since we are setting the value in the URL string, we are required to change the “#” character to its URL Encoding (UTF-8) which is the “%23” symbol I.e “%23FF00BB”.

Specific configuration parameters

ParameterDescription
primaryColorUsed to change the primary color of the content. Color in hexadecimal representation, but using URL Encoding.
Color value : #003865
URL query string value: “%23003865”
secondaryColorUsed to change the secondary color of the content. Color in hexadecimal representation, but using URL Encoding.
Color value : #EF5B0C
URL query string value: “%23EF5B0C”
backgroundColorUsed to change the background color of the main content. Color in hexadecimal representation, but using URL Encoding. Default : #F0F2F5
Color value : #EF5B0C
URL query string value: “%23EF5B0C”

You can change the font family used in the application by setting the fontFamily parameter

📘

Font Availability

Live status Web doesn't support any fonts by default, so make sure you have the fonts available on your site so that the widget can use them

Specific configuration parameters

ParameterDescription
fontFamilyAny font you have available in your platform

Example: monospace

The parameter "language" allows configuring the displaying locales on the application

Supported Locales

👍

Supported Languages

We Follow the ISO 639-1 standard language codes

es: Spanish (Spain)
en: English
pt: Portuguese (Portugal)
pt-br: Portuguese (Brazil)

📘

Default Locale

  • If no language is being set, the app will try to use the locale used by the browser.

  • If no supported language (listed above) is being set by neither the parameter nor the browser, the content will be displayed in Spanish

Specific configuration parameters

ParameterDescription
languageparameter used to change the language of the content

Default: Spanish

📘

Default prices

  • Parameters for showing numerical values.

You can change the display of the currency type, show or hide the decimals in order and decide if the thousand separator is comma or by default.

ParameterDescription
currencyCodeSet the currency code (optional)
Default: Established when creating the order
pricesSeparetedByCommaAllows you to decide if the thousand separator is comma or by default it is kept in point

default: "false"
options: "true" or "false"
hideDecimalsAllows you to show or hide the decimals in order

default: "false"
options: "true" or "false"

With the Active Tabs parameter, you can control what you want to display in the content of the application

You may decide to display only a set of the information available from the order, or even to display the chat when using the application.

We currently support 3 modes in which you can display information

With the Full screen parameter allows you to adjust the margins

👍

Display Modes

  • Chat Tab
  • State Tab
  • Detail Tab
  • Full screen

Specific configuration parameters

ParameterDescription
activeTabsallows you to control what content to present in the application

chatTab: with this value, we will display only the chat view in the application.

detailTab: this will display information details related to the order, like items list and billing summary, but not information regarding the current status/steps the order is at the moment

stateTab: this will display information about the status/steps the order is undertaking.
isFullScreenIt allows you to decide if the screen will be full screen
default: "false".
options: "true" or "false