SECUTIX

https://go.confluence.secutix.com/wiki
Admin
SECUTIX is a cloud-based ticketing and audience management platform designed for the entertainment,...
Tokens:595,113
Snippets:10,935
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Define start function parameters

Source: https://go.confluence.secutix.com/wiki/spaces/DOCEN/pages/41617208

Structure the configuration object required by the widget library's start function, including mandatory hostname and apiKey fields.

```javascript
{ 	hostname: string that represent the hostname of the internet point of sales (mandatory) 	apikey: string that contains the apikey linked to the internet point of sales (mandatory) 	language: string representing the language in which the widgets should be displayed (optional, it takes the default institution language if not provided) 	widgets: a list of widget definitions }
```

--------------------------------

### Widget.start(config)

Source: https://go.confluence.secutix.com/wiki/spaces/DOCEN/pages/41617208

Initializes the widget library by calling the start function with a configuration object containing global settings and a list of widget definitions.

```APIDOC
## Widget.start(config)

### Description
Initializes the widget library and renders widgets into specified HTML containers.

### Parameters
- **hostname** (string) - Required - The hostname of the internet point of sales.
- **apiKey** (string) - Required - The API key linked to the internet point of sales.
- **language** (string) - Optional - The language for widget display (defaults to institution language).
- **widgets** (array) - Required - A list of widget definition objects.

### Widget Definition Object
- **name** (string) - Required - The case-sensitive name of the widget.
- **container** (string) - Required - The ID of the HTML container element.
- **[specific parameters]** (any) - Optional - Additional parameters specific to the chosen widget.
```

--------------------------------

### Supplementary data example

Source: https://go.confluence.secutix.com/wiki/spaces/RN/pages/66225618/New%2BSEPA%2Bversion

An example of the supplementary data schema provided by a bank.

```xml
<SplmtryData>     <PlcAndNm>SEPAISO20022</PlcAndNm>     <Envlp>     <BankInfo xmlns="">Bank for processing for CUBE</BankInfo>   </Envlp> </SplmtryData>
```

--------------------------------

### New DataLayer Structure Example

Source: https://go.confluence.secutix.com/wiki/spaces/RN/pages/43058567/Enhanced%2Be-commerce%2Bdata%2Blayer%2Bfull%2Bdocumentation

Example of the enhanced e-commerce data layer object pushed to the Order Confirmation Page.

```javascript
'ecommerce': { 'purchase': { 'actionField': { 'id': '12345', // File ID 'affiliation': 'MOSA_TSHOP', // OrganizationCode_PoSCode 'revenue': '35.43', // Total order amount (incl.
```

--------------------------------

### STX.Widgets.start(options)

Source: https://go.confluence.secutix.com/wiki/spaces/DOCEN/pages/41617208

Initializes a group of widgets with shared global configuration. Multiple calls can be made to group widgets with different global settings.

```APIDOC
## STX.Widgets.start(options)

### Description
Initializes and renders a group of widgets on the page. Widgets within the same call share global configuration parameters.

### Parameters
- **hostname** (string) - Required - The hostname defined in the point of sales.
- **apiKey** (string) - Required - The API key for authentication.
- **language** (string) - Required - The language code for the widgets (e.g., 'fr', 'en').
- **widgets** (array) - Required - A list of widget objects to initialize.

### Widget Object Properties
- **widget** (string) - Required - The type of widget (e.g., 'Product', 'Catalog').
- **root** (string) - Required - The CSS selector ID of the HTML element where the widget will be rendered.
- **productId** (string) - Optional - The ID of the product (required for 'Product' widget).
- **occurrenceId** (string) - Optional - The ID of the performance, match, or slot (required for 'Product' widget).
- **showActions** (boolean) - Optional - Whether to show action buttons.
- **aspectRatio** (string) - Optional - The display aspect ratio for images (e.g., 'VERTICAL').
- **showDescription** (boolean) - Optional - Whether to show the product description.
- **showImage** (boolean) - Optional - Whether to show the product image.

### Example
<script type="text/javascript">
	STX.Widgets.start({
		hostname: 'host.shop.secutix.com',
		apiKey: '8bafa660-8bc1-4982-83da-f15fce01f4ec',
		language: 'fr',
		widgets: [{
			widget: 'Product',
			root: '#product_1',
			productId: '4654654',
			occurrenceId: '87846578',
			showActions: true,
			aspectRatio: 'VERTICAL'
		}]
	});
</script>
```

--------------------------------

### Instantiate multiple widget groups

Source: https://go.confluence.secutix.com/wiki/spaces/DOCEN/pages/41617208

Demonstrates initializing multiple widget groups with distinct global configurations by calling STX.Widgets.start for each set.

```javascript
<script type="text/javascript"> 	STX.Widgets.start({  		// The hostname defined in the point of sales 		hostname: 'host.shop.secutix.com',  		apiKey: '8bafa660-8bc1-4982-83da-f15fce01f4ec', 		language: 'fr', 		widgets: [{ 			widget: 'Product',			// the name of the widget 			root: '#product_1',			// the id of html tag above 			productId: '4654654',		// the id of the product 			occurrenceId: '87846578',	// the id of performance / match / slot 			showActions: true,			// parameters to show the actions 			aspectRatio: 'VERTICAL'		// how to display the picture 		},{ 			widget: 'Product', 			root: '#product_3', 			productId: '465488', 			occurrenceId: '1129848', 			showDescription: true, 			showImage: false 		},{ 			widget: 'Catalog', 			root: '#catalog_1' 		}] 	});   	STX.Widgets.start({  		// The hostname defined in the point of sales 		hostname: 'host.shop.secutix.com',  		apiKey: '8bafa660-8bc1-4982-83da-f15fce01f4ec', 		language: 'en', 		widgets: [{ 			widget: 'Product',			// the name of the widget 			root: '#product_2',			// the id of html tag above 			productId: '4654654',		// the id of the product 			occurrenceId: '87846578',	// the id of performance / match / slot 			showActions: true,			// parameters to show the actions 			aspectRatio: 'VERTICAL'		// how to display the picture 		}] 	});  </script>
```
Tokens:
Raw