Website Admin
Each Spektrix system has a Website Admin Interface, which controls the configuration of the Iframe booking path as well as the upload of additional web resources, such as stylesheets or custom fonts.
The Web Admin interface can be accessed via the below link. Access can be granted by your client. This is likely to be the only Spektrix interface you would need to access as the web developer.
https://system.spektrix.com/clientname/client/websiteadmin/websiteadmininterfacepage.aspx
clientname should be replaced with the appropriate client name, which can be obtained from either the venue or Spektrix support.
The interface is split between three menus:
- Resources - this section allows you to upload your stylesheet for the Iframes, as well as any other web resources you would like Spektrix to host locally to the Iframes.
- Config - this section is only relevant for API v.2. configs and shows the v.2. API key.
- Domain Specific Config - this section is where the majority of the Iframe settings can be configured.
Domain Specific Config
This section allows you to determine settings for each of the domains that are associated with a client system.
This could be just the one domain of the parent website, if the client is using one website only.
Clients can have multiple domains each with their own integration with a single client system. For example, a client could trade under two names or also have a Festival microsite. In this case both domains would need to be listed.
Listing a domain in Domain Specific Config
When you log in to Website Admin You will land on the Resources tab, this can be used to upload any CSS, fonts or other static content you want to refer to from the Spektrix server.
You can ignore the Config tab, unless you are using APIv2 (you will most likely be using APIv3) and browse straight to Domain Specific Content at which point you will be presented with a screen such as:
- Select "Add New Config" and enter the domain string of your site
- You can now enter the appropriate links and stylesheets for that domain
- These config settings will now be applied to the Iframes that have been integrated into that domain
The listed domain must be in the format: mywebsite.com, rather than https://www.mywebsite.com and match the root domain of your custom domain. For example, if your custom domain is tickets.mywebsite.com, the listed domain in Domain Specific Config must be mywebsite.com. If you omit adding it, it is likely you will encounter errors.
If the client is working with multiple websites, you must list every domain.
Listing subdomains in Domain Specific Config
It is possible to also list domains that consist of a subdomain and root domain. For example, you may want to list a staging website such as staging.mywebsite.com. Or a festival microsite such as festival.mywebsite.com. Either of these domains would use the custom domain tickets.mywebsite.com for embedded iframes, client side API calls and web components.
If you are working with Spektrix Link, the domain you would list is the customer facing subdomain, such as purchase.mywebsite.com.
In order to ensure that the listed domain obeys the correct settings, you must set the Referrer-Policy on the parent website to: strict-origin-when-cross-origin. More information about referrer-policy here: Referrer-Policy - HTTP | MDN. Once that is set, you should see that the Referer of the iframe is the correct subdomain.
Updating the Default
Default should contain the same settings as your main domain. If you only have one domain, then you just duplicate the same settings. If you have multiple domains, select the one with the most traffic / the one you consider the main domain for this system, and add those settings. See below for more information on settings.
CORS erros
If you are seeing any CORS errors in your integration, this may be due to - but not limited to:
- Not having the Domain you are using as a named Domain Config inside of Website Admin.
- Using a custom domain that is not a subdomain of the parent site.
- Sending incorrect payload information via the API.
- Not explicitly including cookies as part of your call in order to share a session.
Please reach out to the support team if you are struggling to diagnose CORS errors. To help the team diagnose them, send the error as it appears.
Configuring the settings in Domain Specific Config
| Fields: | ||
|---|---|---|
| Sold Out Message | Optional | This field can be edited to tell users what to do if an event becomes sold out. It shows at all times in the customer interface at the point a user selects an instance they would like to see and is independent of the status of the availability. |
| Website Contact Email Address | Depreciated | This tool is no longer used for integrations and will be removed in a future release. |
| Default Style Sheet | Required | This table shows the full list of available stylesheets uploaded in the resources menu. An option must be selected for the integration to work correctly, even if there is only a single stylesheet uploaded. |
| Checkout Link: | Required | This field should be set to the URL of the page on the website that hosts the IFrame which points at the checkout in the customer interface. |
| MyAccount Link: | Required | This field should be set to the URL the address of the "My Account" page on your website |
| Custom Basket Link | Optional (Requires the use of custom domains) | This field is optional if the website uses basket2.aspx and is mandatory if it uses a custom basket. If a URL is set here, the customer will be redirected to this page when they reach the basket as part of the iframe booking flow. |
| Password Reset Page Link: | Optional (Required when using the Express Checkout) | This field should be set to the URL address of the page on your website where a customer can reset their password. If this is not set it defaults to the Checkout Link above. |
| Redeem Gift Page Link: | Optional | Set this field if you have a specific page on your website, where the redeem gift Iframe is embedded. If this is not set it defaults to the Checkout Link above. |
| Basket "Book more tickets" Link: | Optional | If this field is filled in, a 'continue browsing' button appears in the basket/cart. This link should point to the url for the Event List of the parent site. |
| Account Login Link: | Required | This field should be set to a URL, where a customer can log in. More often than not it will be the same url as the MyAccount Link above. |
| Website JavascriptOptions: | Required | This field allows you to switch on tools in the Iframes that are powered by Javascript. A blank page from the client website is needed to enable javascript, the URL to which should be entered in this field. It is also possible to enable IFrame Resizing here. |
| Event Details URL Template | Optional | Set this to be the address template of the event detail pages on your website. Must be either of the form https://websiteAddress/{EventId}/details or https://websiteAddress/{WebEventId}/details |
| Use Express Checkout Flow | Optional | Switches on the Express Checkout. We recommend almost all integrations should use this flow. |
| Cookie Options | Optional | Enter the url of a page on your website providing information about enabling cookies for users who have them disabled. You may wish to use the Spektrix Cookies.aspx iFrame on this page. |
| IFRAME Settings | Depreciated | This tool is no longer used for integrations and will be removed in a future release. |
| Specify HTML Headers | Optional | This field allows users to add HTML to the headers of every page on the customer interface. This field is useful for adding Google Tag Manager and Pixel tracking of conversions. |
| Specify HTML Immediately After the Opening <body> Tag | Optional | This field allows users to add HTML after the opening <body> tag of every page on the customer interface. This field is useful for adding Google Tag Manager and Pixel tracking of conversions. |
| Specify HTML Headers Specific to Confirmation Page | Optional | This field allows users to add HTML to the headers of only the confirmation page. This field cannot be used with the Express Checkout. |
| Specify HTML Immediately After the Opening <body> Tag Specific to Confirmation Page | Optional | This field allows users to add HTML immediately after the opening <body> tag of only the confirmation page. This field cannot be used with the Express Checkout. This field and the above three fields are useful for aiding Google Tag Manager and Pixel tracking of conversions. |
| Google Analytics Options | Optional | This field powers the older Google Analytics integration. Please note, if you are using Google Tag Manager, this setting should not be used, as otherwise you will double count visitors. |
Setting up your Dev Site with Spektrix
The easiest way to set up your development site is to connect it directly to the live instance of Spektrix the site will ultimately be using (or the latest ‘run’ system, if you are developing your site for a client who has yet to go live with Spektrix).
We use Domain Specific Config in the system, which allows multiple websites to run off one instance of Spektrix, without the different configurations interfering with one another. This means you can set up your dev site without needing to change any settings that will compromise the venue’s current website.
Why not use a ‘sandbox’ version of the system?
Spektrix is a highly configurable platform and venues are able to create custom attributes and configurations with ease. Using a sandbox means you cannot guarantee that you are developing a site that will be fully compatible with the venue’s live system and can lead to unintended bugs when your site goes live.
By connecting directly to a live system, you will therefore ultimately reduce workload for both your team and the venue. Also by receiving live data you can get a better feel for how the venue use their Spektrix system and catch snags earlier in the process, which will allow you to produce a better quality website in a shorter time frame.
What you will need?
- A login to the venue’s Spektrix system with the Web Integration Administrator
permission - this will give you access to the Web Site Admin interface, where Domain Specific Config is setup. Your contact at the venue will be able to set this up for you.
( Note: your Spektrix contact will not be able to set your account up for you, since the act of creating an account is the venue giving you permission to access their data) - The venue’s Client Name. Your contact at either the venue or Spektrix can supply this or it can be found in any system URL related to the venue and will normally be the venue’s name in lower case e.g. yourtheatre
- A unique, static domain for your development site - this allows the system to establish which website an Iframe is embedded into.