400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
Access Restricted
Sorry, this content is not available in your region.
Your IP address has been identified as not originating from the United States. For compliance reasons, we cannot grant access to users outside this region.
If you believe you have received this message in error, please contact support atsupport@example.com.
You are being redirected...
``` Take a closer look at `Cache-Control`. The maximum caching age value is set by the server and cannot be changed. The server will direct the viewer to cache the response for 24 hours. ##### Validation rules For the URL path: - Must not contain leading or trailing slashes. E.g., `/about-us/` must be corrected to `about-us`. - Must be already URL encoded. E.g., `about us` must be corrected to `about%20us`. - Must not contain anything other than alphanumeric characters, forward slash, period, and dash. It should match `^[a-z0-9]+([./-][a-z0-9]+)*$` regular expression. - Must not contain query parameters. E.g., `about-us?utm_source=google` must be corrected to `about-us`. For the complete URL: - Must contain the `URL` schema. E.g., `example.staircase.co` must be corrected to ``. - Must not contain query parameters. E.g., `must be corrected to`. - Must not contain fragment identifiers. E.g., `must be corrected to`. ##### Use cases ##### Internal redirects Redirect to a different URL on the same domain name. ###### Problem statement We need to redirect all requests from the old pricing.html page to the new pricing page located at a different URL path, ensuring this redirection is permanent. ###### Configuration ``` { ... "layout_configuration": { ... }, "analytics": { ... }, "path_mappings": [ { "from_path": "pricing.html", "to_path": "pricing" }, { "from_path": "legal-terms.html", "to_path": "legal" } ] } ``` We have added a new path mapping rule to the flow configuration, which will redirect all requests from `pricing.html` to `pricing` path. ##### External redirects Redirect to a different URL on a different domain name. ###### Problem statement We would like to move part of the existing application, to a completely new site configuration, under the different domain name. It's currently hosted on `and we would like to move it to`. ###### Configuration ``` { ... "layout_configuration": { ... }, "analytics": { ... }, "path_mappings": [ { "from_path": "exchange", "to_path": "" } ] } ``` We have added a new path mapping rule to the flow configuration, which will redirect all requests from `exchange` to `` path. ##### Notes ###### Custom Domains When you change `path_mapping` in the Site configuration, remember to sync the Site deployments. - Register Configuration with `path_mappings` configuration. - Deploy Configuration to the distribution network. - Synchronize custom Site. #### Custom Authentication Site provides a way to manage the authentication of the user using custom console app. Authentication requirement can be defined in the Site configuration as following using `authentication_action`. ##### Communication ###### Query Parameters The following parameters are loaded | Parameter | Description | | --- | --- | | `next_console_app_configuration_id` | The next console app configuration that should be loaded on Site, once the user was authenticated | | `authentication_action` | Authentication intent defined in the Site configuration or requested by another console app via the Site Event. | | `authentication_state` | Authentication state key. A short random string generated by Site, the Authentication app is expected to put this key in the redirect URLs for `SignUp` and `Sign In by SSO` authentication flows | | `authentication_origin` | Authentication origin. The current Site URL instantiating the authentication flow. | ###### Events The following event is expected to be emitted by the custom console app to the Site. ``` { "$schema": "", "type": "object", "properties": { "listener": { "type": "string", "description": "Site product identifier.", "enum": [ "e9cc145f-9d03-422e-ba71-1852885998e6" ] }, "authentication_completed": { "type": "boolean", "description": "Describes whether the authentication flow has been completed.", "enum": [true] }, "next_console_app_configuration_id": { "type": "string", "description": "Describes the console app configuration. Tells the Site to load an app marked by this field." }, "auth": { "type": "object", "description": "What authentication context screen to load.", "properties": { "access_token": {"type": "string"}, "id_token": {"type": "string"}, "refresh_token": {"type": "string"} } } }, "required": [ "listener", "next_console_app_configuration_id", "auth", "authentication_completed" ] } ``` ###### Cookies When the user is redirected back to site after Sign In by SSO or Sign Up authentication flow, site instructs browser to store a cookie named `accessToken` with the value of the access token provided in the URL hash. e.g., when visiting site with ``, the Site will instruct user's browser engine to store a cookie named `accessToken` with a value `1234`. Additionally, cookie will have the following attributes: - `Domain` – the domain name will be bound to the environment FQDN currently serving the backend APIs. e.g., `production.staircaseapi.com` - `Path` – the path will be bound to the root path `/`. - `Secure` – the cookie will be marked as secure to be transmitted to HTTPS origins exclusively. - `HttpOnly` – the cookie will not be accessible via JavaScript. It can only by the CDN request interceptor (CloudFront functions), or an API accessible under the same domain name. - `SameSite` – the value will be set to `None` to avoid improper cookie setting given the iframe context. - `Expires` – the value will be set to expire in 6 hours from when the request has been made. Currently, the `__sc.acact` cookie (represent the access token) set by site is considered as a third-party cookie, so you must apply caution when using API calls for authentication. ##### Example ``` { "authentication": { "enabled": true, "show_authentication_on_load": false, "console_app_configuration": { ... } } "layout_configuration": { "main": { ... "console_app_configurations": [ { "console_app_configuration_id": "6374c7f8-13fa-454a-8587-bd2972434bbb", "temporary__console_app_url": "/6374c7f8-13fa-454a-8587-bd2972434bbb-copy34/", "authentication_action": "signin", "url_suffix": "/conversations" } ] } } } ``` Before accessing `/conversations` the user, if not already authenticated, will be redirected to the `/signin` path and the custom console app will be loaded for authentication. ##### Advanced ###### State Exchange Custom authentication apps should utilize `authentication_state` to provide smooth user experience. Upon loading in an iframe, the app receives a query parameter: `authentication_state`, a short string of random characters. It's crucial to retain the authentication state, particularly when the authentication flow is interrupted by external redirections. Common scenarios include Sign Up processes, and authentications via SSO providers like Google, Amazon, or Facebook. The app should provider users with a link for redirection whenever necessary based on the authentication scenario. The Sign Up process is notable as it requires redirection from an email link for account activation. The site expects the "return" of the state key in the URL hash. ###### Example ``` Login using Google ``` In this example: - The app is loaded in an iframe and receives the authentication_state parameter. - During the authentication flow, a redirection for Google login is required. The user is provided a link to login via Google. - Upon clicking the link, the user completes the Google login process. - The user is redirected back to test.staircase.co with the URL hash `#state=p1d048R`. - The site, having associated this state with the data in local storage, uses it to load the most recently used console app. This scenario emphasizes the importance of managing the `authentication_state` parameter effectively to maintain a smooth user experience in cases involving external redirections like authentication via SSO. ###### Soft Authentication Everything described above is considered as a soft authentication. It does force authentication on the user, but it does not validate the user's identity. The user can easily bypass the authentication. Soft authentication is useful for when it's not required to validate the user's identity. ###### Authorization Forced validation cannot be achieved via the Site configuration. There will always be a way to bypass the authentication, instead apps must apply the Cookie validation logic to ensure the user is authenticated. The cookie validation can simply be achieved by validating the JWT token stored in the `__sc.acact` cookie, which represent access token from Access. If the app has an API it communicates with to retrieve the data that should not be generally available, the API must implement the access token validation logic to ensure the user is authenticated. The Site product enables such functionality by setting `HttpOnly` cookies accessible to every API that the console app consumes. #### Console App and Site Communications The Site allows two-way communication between the Site and the Apps using `postMessage` method. ##### Console App to Site Embedded Apps can communicate with the Site using `window.parent.postMessage(payloadObject, "*");`. `postMessage` was introduced to eliminate API calls from the Apps to Site endpoints. A unit of communication is a "message", which in itself is a JavaScript object with a required property `listener`. The value for the `listener` must correspond to the Site product identifier. Fact: Site product identifier is `e9cc145f-9d03-422e-ba71-1852885998e6` The list of events accepted by Site is described below. ###### Relocate the User ``` { "$schema": "", "type": "object", "properties": { "listener": { "type": "string", "description": "Site product identifier.", "enum": [ "e9cc145f-9d03-422e-ba71-1852885998e6" ] }, "relocation_action": { "type": "string", "description": "Describes the action to be taken by the Site.", "enum": [ "REPLACE_CURRENT_URL", "OPEN_NEW_TAB", "OPEN_DEFAULT" ] }, "relocation_url": { "type": "string", "description": "The URL to be loaded by the Site." } }, "required": [ "listener", "relocation_action", "relocation_url" ] } ``` ###### Toggle Popup Note: `layout_configuration` should contain `popup` definition for the toggle to work. ``` { "$schema": "", "type": "object", "properties": { "listener": { "type": "string", "description": "Site product identifier.", "enum": [ "e9cc145f-9d03-422e-ba71-1852885998e6" ] }, "style": { "type": "object", "description": "Styling attributes. Standard CSS attributes.", "additionalProperties": { "type": "string" } }, "showPopup": { "type": "boolean", "description": "Marks the popup state. Use `true` – to show, `false` – to hide popup." } }, "required": [ "listener", "style", "showPopup" ] } ``` ###### Load Authentication Page ``` { "$schema": "", "type": "object", "properties": { "listener": { "type": "string", "description": "Site product identifier.", "enum": [ "e9cc145f-9d03-422e-ba71-1852885998e6" ] }, "auth_screen": { "type": "string", "description": "What authentication context screen to load.", "enum": [ "signin", "signup", "forgot-password", "forgot-password-update" ] } }, "required": [ "listener", "auth_screen" ] } ``` The feature can also be accessed via the configuration via `authentication_action` field under `layout_configuration.main.console_app_configurations[*]`. ###### Logout the User Note: You can define `logout_url` under `layout_configuration.authentication` to redirect the user to the desired URL after the authentication reset. ``` { "$schema": "", "type": "object", "properties": { "listener": { "type": "string", "description": "Site product identifier.", "enum": [ "e9cc145f-9d03-422e-ba71-1852885998e6" ] }, "logout": { "type": "boolean", "description": "Whether to logout the user. Can only be `true`.", "enum": [ true ] } }, "required": [ "listener", "logout" ] } ``` ###### Load Console App Note: `console_app_configuration_id` should be present among console app configurations registered for the active flow configuration, and not just any console app configuration identifier. ``` { "$schema": "", "type": "object", "properties": { "listener": { "type": "string", "description": "Site product identifier.", "enum": [ "e9cc145f-9d03-422e-ba71-1852885998e6" ] }, "console_app_configuration_id": { "type": "string", "description": "Describes the console app configuration. Tells the Site to load an app marked by this field." } }, "required": [ "listener", "console_app_configuration_id" ] } ``` ###### Change Browser Tab URL Note: `url_suffix` property should be a path, not a full URL. ``` { "$schema": "", "type": "object", "properties": { "listener": { "type": "string", "description": "Site product identifier.", "enum": [ "e9cc145f-9d03-422e-ba71-1852885998e6" ] }, "url_suffix": { "type": "string", "description": "URL to be set in user's browser tab." } }, "required": [ "listener", "url_suffix" ] } ``` Warning: This feature is exclusive to site configurations with a single console app configuration. ###### Send Custom Tracking Event Sends a custom tracking event to the analytics provider. Right now only Google Tag Manager and Facebook Pixel are supported. It is recommended to use Google Tag Manager and manage data destinations from there, including Facebook Note: This will work only if the `analytics` configuration is present in the flow configuration. ``` { "$schema": "", "type": "object", "properties": { "listener": { "type": "string", "description": "Site product identifier.", "enum": [ "e9cc145f-9d03-422e-ba71-1852885998e6" ] }, "externalFeedbackProvider": { "type": "string", "enum": ["pixel", "gtm"] }, "type": { "type": "string", "example": "trackCustom" }, "action": { "type": "string" }, "data": { "type": "object" } }, "required": [ "listener", "externalFeedbackProvider", "action", "data" ] } ``` ###### Restyle Console App ``` { "$schema": "", "type": "object", "properties": { "listener": { "type": "string", "description": "Site product identifier.", "enum": [ "e9cc145f-9d03-422e-ba71-1852885998e6" ] }, "style": { "type": "object", "additionalProperties": true, "description": "Apply different than original styles dynamically using a set of key-value pairs where the keys are CSS properties" }, "target": { "type": "string", "description": "A site component placeholder, which requires a change in styling.", "enum": ["header", "left_sidebar", "right_sidebar", "footer", "hero", "main"] } }, "required": [ "listener", "style", "target" ] } ``` ###### Dynamically Resizing Main Layout In order to keep the footer on the bottom of the page, the main layout height should be adjusted dynamically. To its dynamic height. The following example demonstrates how to use `ResizeObserver` to monitor document height changes, and send a message to the Site to adjust the height of the main layout. ``` const emitResizeSelfDimensions = ({height}) => { const resizeMeEvent = { listener: "e9cc145f-9d03-422e-ba71-1852885998e6", style: {height}, target: "main" }; window.parent.postMessage(resizeMeEvent, '*'); } const resizeObserver = new ResizeObserver( entries => { for (let entry of entries) { const newHeight = entry.contentRect.height; emitResizeSelfDimensions({height: newHeight}); } } ) resizeObserver.observe(document.body) ``` Important: Site automatically applies `margin-top` and `z-index` for the header, so it's kept on top while scrolling. ###### Pass on the Data When the `payload` property is passed together with `direction` or `console_app_configuration_id` fields, Site converts that value into the URL-encoded string and passes it to the console app configuration as a query parameter. ``` { "$schema": "", "type": "object", "properties": { "listener": { "type": "string", "description": "Site product identifier.", "enum": [ "e9cc145f-9d03-422e-ba71-1852885998e6" ] }, "console_app_configuration_id": { "type": "string", "description": "Describes the console app configuration. Tells the Site to load an app marked by this field." }, "direction": { "type": "string", "description": "Describes the direction of the flow. Tells the Site what to load next.", "enum": ["backward", "forward"] }, "payload": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "listener" ] } ``` ###### Refresh access and ID tokens Site allows refreshing the access and ID tokens by sending a message to the Site if refresh token is persisted. Note, that currently refresh token is generated by Access only for email-password flow and is not provided for SSO. If your application uses custom auth app, that app have to send refresh token to the Site ``` { "$schema": "", "type": "object", "properties": { "listener": { "type": "string", "description": "Site product identifier.", "enum": [ "e9cc145f-9d03-422e-ba71-1852885998e6" ] }, "eventType": { "type": "string", "description": "Event type.", "enum": [ "refreshAccessToken" ] } }, "required": [ "listener", "eventType" ] } ``` ###### Data-driven Site Flow If none of `console_app_configuration_id` or `direction` were provided, the Site will treat the flow as conditionally driven. It will go through every console app configuration until it matches provided data to a specified condition. ##### Site to Console App Embedded Apps can listen to the Site event using `window.addEventListener`. In the case of Site to Console App communication the value for the `listener` corresponds to the console application configuration receiving the message. Every message sent by the Site to the Console App has a fixed structure. ``` { "$schema": "", "type": "object", "properties": { "listener": { "type": "string", "description": "Console application configuration identifier." }, "eventType": { "type": "string", "description": "Describes the event type that has occurred.", "enum": [ "main_app_change" ] }, "eventPayload": { "type": "object", "description": "Event payload. Varies depending on the event type." } }, "required": [ "listener", "eventType" ] } ``` ###### The Main Console App Has Changed The current main application configuration has changed to a different one. Warning: When a non-main console application configuration with `inherit_main_url: true` gets initialized, it is not guaranteed that the event will be emitted to the console application through the Site. Instead, the console application can rely on `main_url_path` passed as a query parameter when loading the console application. Same goes for `is_authenticated` ``` { "$schema": "", "type": "object", "properties": { "listener": { "type": "string", "description": "Console application configuration identifier." }, "eventType": { "type": "string", "description": "Describes the event type that has occurred.", "enum": ["main_app_change"] }, "eventPayload": { "type": "object", "description": "Event payload. Can contain additional properties depending on the `change_reload_url_params` definition in the console app configuration.", "required": ["console_app_configuration_id", "is_authenticated"], "properties": { "main_url_path": { "type": "string", "description": "URL path of the main console app configuration. Provided if `inherit_url_path` is enabled." }, "console_app_configuration_id": { "type": "string", "description": "Console app configuration identifier of the switched app." }, "is_authenticated": { "type": "boolean", "description": "Correlation flag. Indicates whether the user is authenticated or not." } } } }, "required": [ "listener", "eventType", "eventPayload" ] } ``` Warning: Do not use `is_authenticated` flag for authorization purposes. It's only meant to be used to correlate the state between site and console applications. ##### Ratio Based Application Loading Main console application configuration can be configured to load different applications based on the ratio. The main use-case for the ratio based application loading is A/B testing on the level of the application configuration. When rendering such application, the Site will randomly select one of the application configurations (defined in `ratio_based_console_app_configurations` under the main application configuration) based on the ratio defined in the configuration. Site uses weighted random selection to determine which application configuration to load. Note: Defining the ratio based applications still requires defining the `console_app_configuration_id` and `temporary__console_app_url` properties. ###### Validation Rules The following rules are designed to ensure the ratio based application loading is configured correctly: - `ratio_based_console_app_configurations` must contain the original application configuration in the list of the alternative application configurations. - Each application configuration under `ratio_based_console_app_configurations` must contain the `ratio`. - The ratio for each application configuration must be a positive number greater than `0.0` and less than `1.0`. - The sum of all ratios must be equal to `1.0`. Navigate to endpoint request payload Flow with A/B Applications example to see the example of the ratio based application site configuration. ##### Conditional flows Conditional flows are a particular way of Site flows where the logic of which App should be displayed depends on the data passed in `postMessage`. First, the Site configuration should contain `condition` property set on all Apps except the first one. An example: ``` ... "console_app_configurations": { "console_app_configuration_id": "6374c7f8-13fa-454a-8587-bd2972434bbb", "temporary__console_app_url": "", "url_suffix": "/welcome" }, { "console_app_configuration_id": "6374c7f8-13fa-454a-8587-bd2972434ccc", "temporary__console_app_url": "", "url_suffix": "/option-one", "condition": { "path": "optionSelected", "operation": "equal", "value": "1" } }, { "console_app_configuration_id": "6374c7f8-13fa-454a-8587-bd2972434ddd", "temporary__console_app_url": "", "url_suffix": "/option-two", "condition": { "path": "optionSelected", "operation": "equal", "value": "2" } } } ... ``` When the Site is opened, the `/welcome` page will be displayed. Let's assume that `/welcome` page contains some form and, depending on the value selected by the User, one of the other two Apps should be displayed. After the User submits the value on `/welcome` App, the App invokes `window.parent.postMessage({"listener": "e9cc145f-9d03-422e-ba71-1852885998e6", "payload": {"optionSelected": submitedValue}}, "*");` with `submitedValue`. The Site receives the payload, checks for the conditions and if the `submitedValue` is equal to 1 displays `/option-one` App or `/option-two` if the `submitedValue` is equal to 2. The Site passes to the App `optionSelected` as a query parameter, for example, if `submitedValue` was equal to 2 it will load the App like ``. Note: - if the condition passed in `postMessage` payload does not match any of the conditions in the Site configuration, the User will remain on the same App - if multiple Apps conditions match the passed payload, the first one will be displayed - the Site does not do casting when comparing conditions and treats all values as strings ###### Using complex conditions The Site allows conditions to be complex using `and` and `or` operations. Example of such Site configuration: ``` ... { "console_app_configuration_id": "6374c7f8-13fa-454a-8587-bd2972434ddd", "temporary__console_app_url": "", "url_suffix": "/option-two", "condition": { "and": [ { "path": "optionSelected", "operation": "equal", "value": "1" }, { "path": "userAge", "operation": "greatherThan", "value": "21" } } } } ... ``` In this case, conditions are matched if only both `optionSelected` equals 1 and `userAge` is greater than 21. Similarly, using `or` operator instead of `and` will be matched if one of the conditions is meet. #### User State & Workflows Warning: Workflows can only be used for flows with authentication enabled. If the site visitor is not authenticated and tries entering the workflow, they will be directed to the authentication page. Workflows help in consistently saving user state data between various console app settings. A workflow is essentially a blueprint detailing the user's journey. You have the option to set up to 10 distinct workflows for each site configuration. It's crucial that every workflow is marked with a unique identifier and its corresponding path. When a user wraps up a state (in this case, a console app), the app then signals the completion to the Site. Subsequently, the Site initiates the loading of the forthcoming state. Should a user return to the site, the Site will automatically load their most recent state, presenting it directly to the user. ##### Defining a Workflow The framework to define a workflow resemble the [States Language seen in AWS Step Functions. However, it's a more condensed structure. Key distinctions include: - The `Type` property of a State can solely be `App`. - The `Resource` pertains to a console app configuration ID. - Every `States` should possess a distinctive `Resource` property. ##### Events for Workflows ###### State Done Tells site to load the Next app in the workflow. If the current state is terminal (`End: true`) nothing is changed. ``` { "$schema": "", "type": "object", "properties": { "listener": { "type": "string", "description": "Site product identifier.", "enum": [ "e9cc145f-9d03-422e-ba71-1852885998e6" ] }, "state_done": { "type": "boolean", "description": "Represents the state completion by the user. Can only be `true`.", "enum": [ true ] } }, "required": [ "listener", "state_done" ] } ``` ###### Switch Workflow Tells site to load to switch from one workflow to a different one. If the workflow specified does not exist – nothing will change. ``` { "$schema": "", "type": "object", "properties": { "listener": { "type": "string", "description": "Site product identifier.", "enum": [ "e9cc145f-9d03-422e-ba71-1852885998e6" ] }, "workflow_id": { "type": "string", "description": "Represents the workflow identifier." } }, "required": [ "listener", "workflow_id" ] } ``` ##### URL Paths & Workflow Each workflow is tied to a specific path. When a user accesses a URL that matches this path, they are directed into that particular workflow. Note that a workflow will absorb all `url_suffix`es defined for states in `Resource`. This implies that if a `url_suffix` is set, it must be distinctly different from other `url_suffix` definitions. See an example for a workflow definition in an example named "Stateful". Important: Modify identifiers for both site and console app configurations before using examples below. ##### Custom domain for backend and console apps The Site product allows you to use a custom domain for the backend and console apps. To use a custom domain you need to add `backend.domain_name` to your site configuration. Site will use this domain to load the console apps and to make requests to the backend. Example: ``` { "backend": { "domain_name": "api.example.com" } } ``` ##### Request SimpleOpen Graph TagsA/B AppsAnalytics EnabledStateful application/json Copy ``` { "site_flow_configuration_id": "345e8795-eb14-24t3-a2-aaaa174000", "site_flow_product_id": "345e8795-eb14-24t3-a2-aaaa174001", "layout_configuration": { "authentication": { "enabled": false }, "left_sidebar": { "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174002", "temporary__console_app_url": "/left-sidebar-url", "style": { "width": "250px", "height": "100%" } }, "header": { "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174003", "temporary__console_app_url": "/header-url", "style": { "width": "100%", "height": "50px" } }, "hero": { "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174013", "temporary__console_app_url": "/hero-url", "style": { "width": "100%", "height": "50px" } }, "footer": { "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174004", "temporary__console_app_url": "/footer-url", "style": { "width": "100%", "height": "30px" } }, "main": { "title": "My website", "style": { "width": "100%", "height": "80px", "padding": "10px 20px" }, "rendering_type": "flow", "console_app_configurations": [ { "title": "Credentials", "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174006", "temporary__console_app_url": "/app1", "url_suffix": "/credentials" }, { "title": "Configuration Settings", "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174007", "temporary__console_app_url": "/app2", "url_suffix": "/configuration-settings" }, { "title": "Partner Options", "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174008", "temporary__console_app_url": "/app3", "url_suffix": "/partner-options" } ] } } } ``` application/json Copy ``` { "site_flow_configuration_id": "345e8795-eb14-24t3-a2-aaaa174007", "site_flow_product_id": "345e8795-eb14-24t3-a2-aaaa174005", "analytics": { "google_analytics_tag": "G-A1BCD2EF3H" }, "open_graph_tags": { "title": "Staircase", "description": "Staircase is a platform for building and deploying web applications.", "image": "https://www.datocms-assets.com/media/example-icons-favicon-dark.ico", "type": "website", "url": "https://www.staircase.co", "site_name": "Staircase", "locale": "en_US" }, "layout_configuration": { "authentication": { "enabled": false }, "main": { "title": "Constant Feedback (Beta)", "rendering_type": "list", "console_app_configurations": [ { "title": "Options", "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174006", "temporary__console_app_url": "/a827000000" }, { "title": "Application submission", "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa1748931", "temporary__console_app_url": "/a0987627892", "url_suffix": "/application" } ] } } } ``` application/json Copy ``` { "site_flow_configuration_id": "345e8795-eb14-24t3-a2-aaaa174000", "site_flow_product_id": "345e8795-eb14-24t3-a2-aaaa174001", "layout_configuration": { "authentication": { "enabled": false }, "main": { "title": "A/B Website", "rendering_type": "list", "console_app_configurations": [ { "console_app_configuration_id": "145e8795-eb14-24t3-a2-aaaa174006", "temporary__console_app_url": "https://bing.com", "ratio_based_console_app_configurations": [ { "ratio": 0.5, "console_app_configuration": { "console_app_configuration_id": "145e8795-eb14-24t3-a2-aaaa174006", "temporary__console_app_url": "https://bing.com" } }, { "ratio": 0.5, "console_app_configuration": { "console_app_configuration_id": "245e8795-eb14-24t3-a2-aaaa174007", "temporary__console_app_url": "https://google.com" } } ] } ] } } } ``` application/json Copy ``` { "site_flow_configuration_id": "345e8795-eb14-24t3-a2-aaaa174007", "site_flow_product_id": "345e8795-eb14-24t3-a2-aaaa174005", "analytics": { "google_analytics_tag": "G-A1BCD2EF3H", "mouseflow_project_identifier": "0710f46a-9441-11ee-8acf-6ae56c4923a6" }, "layout_configuration": { "authentication": { "enabled": false }, "main": { "title": "Constant Feedback (Beta)", "rendering_type": "list", "console_app_configurations": [ { "title": "Options", "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174006", "temporary__console_app_url": "/a827000000" }, { "title": "Application submission", "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa1748931", "temporary__console_app_url": "/a0987627892", "url_suffix": "/application" } ] } } } ``` application/json Copy ``` { "site_flow_configuration_id": "27372a78-0aae-4bbd-a9be-80688d6346cc", "site_flow_product_id": "a699d986-08b7-4012-bb6f-421d7ae2ce4f", "layout_configuration": { "authentication": { "enabled": true, "show_authentication_on_load": false }, "main": { "title": "Milestone", "rendering_type": "flow", "console_app_configurations": [ { "console_app_configuration_id": "0231ae28-b9cc-4d89-bbaf-ca344d215a7f", "temporary__console_app_url": "/0231ae28-b9cc-4d89-bbaf-ca344d215a7f/", "url_suffix": "/contract" }, { "console_app_configuration_id": "56773f9b-4cea-4faa-b028-670f254fc59e", "temporary__console_app_url": "/56773f9b-4cea-4faa-b028-670f254fc59e/", "url_suffix": "/agree" }, { "console_app_configuration_id": "3e12cbff-fb66-41f3-96be-30835c6d0317", "temporary__console_app_url": "/3e12cbff-fb66-41f3-96be-30835c6d0317/", "url_suffix": "/filter" }, { "console_app_configuration_id": "d901517a-a530-488e-bc4d-3005b4d2288f", "temporary__console_app_url": "/d901517a-a530-488e-bc4d-3005b4d2288f/", "url_suffix": "/subscribe" }, { "console_app_configuration_id": "37556e03-9681-461f-ade3-4b38c6a8e2ef", "temporary__console_app_url": "/37556e03-9681-461f-ade3-4b38c6a8e2ef/", "url_suffix": "/milestone" }, { "console_app_configuration_id": "675ba25d-2b29-40b3-8d83-d93d31b88cb3", "temporary__console_app_url": "/675ba25d-2b29-40b3-8d83-d93d31b88cb3/", "url_suffix": "/profile-settings" } ] } }, "workflows": [ { "id": "12345678-82eb-4522-bc47-f0fcfdd00001", "path": "/", "definition": { "StartAt": "Contracting", "States": { "Contracting": { "Type": "App", "Resource": "0231ae28-b9cc-4d89-bbaf-ca344d215a7f", "Next": "Agreement" }, "Agreement": { "Type": "App", "Resource": "56773f9b-4cea-4faa-b028-670f254fc59e", "Next": "Observatory" }, "Observatory": { "Type": "App", "Resource": "37556e03-9681-461f-ade3-4b38c6a8e2ef", "End": true } } } }, { "id": "12345678-82eb-4522-bc47-f0fcfdd00002", "definition": { "StartAt": "Filters", "States": { "Filters": { "Type": "App", "Resource": "3e12cbff-fb66-41f3-96be-30835c6d0317", "Next": "Subscriptions" }, "Subscriptions": { "Type": "App", "Resource": "d901517a-a530-488e-bc4d-3005b4d2288f", "End": true } } } } ] } ``` ##### Response 400422 application/json Copy A 400 status code occurs when some of provided request parameters is invalid. ``` { "error": { "message": "Bad Request", "reason": "Provided token is not valid." } } ``` application/json Copy A 422 status code occurs when a request is well-formed, however, due to semantic errors it is unable to be processed. ``` { "error": { "message": "Unprocessable entity.", "reason": "Domain name could not be validated." } } ``` ##### Request body`application/json` 10 fields | Field | Type | Description | | --- | --- | --- | | `site_flow_configuration_id` | `string` | The ID of the site configuration.Example `15a820a6-cac9-4b-a7b1-d364b26d7f69` | | `site_flow_product_id` | `string` | The ID of the site flow product.Example `6c5f392f-1ee7-41-9a3d-3b2d08b954fd` | | `analytics` | `object` | Analytics configuration. | | `google_analytics_tag` | `string` | Google Analytics tag.Example `G-A1BCD2EF3H` | | `google_analytics_server_url` | `string` | Google Analytics Container Server URL.Example `https://ss-tagging.moore-dev.staircaseapi.com` | | `advertiser_correlation_key` | `string` | Advertiser correlation key.`utm_source`Example `utm_source` | | `mouseflow_project_identifier` | `string` | Mouseflow project identifier.Example `0710f46a-9441-11ee-8acf-6ae56c4923a6` | | `google_analytics_tracking_parameters` | `string[]` | List of GA custom tracking parameters. | | `facebook_pixel_id` | `string` | Facebook pixel ID.Example `1234567890123456` | | `facebook_pixel_domain_verification` | `string` | Facebook tracking domain name verification to be put in meta head tag.Example `1234567890123456` | | `google_tag_manager_id` | `string` | Google Tag Manager ID.Example `GTM-123456` | | `layout_configuration` | `object` | Site layout configuration. | | `favicon` | `object` | Favicon schema. | | `blob_id` | `string` | Blob identifier from Persistence.Example `01H0JANT98QNERDF7EV0S2JJJJ` | | `blob_url`required | `string` | Blob URL.Example `https://cdn.edge.staircaseapi.com/media/si_oi9ju8hy7t627892iju4872h4ucnhwebf32eicmcmji349mmc33im3/favicon-dark.ico` | | `authentication` | `object` | Authentication schema. | | `enabled` | `boolean` | Whether authentication is enabled.Example `true` | | `show_authentication_on_load` | `boolean` | Should the authentication immediately on site load, default TrueExample `true` | | `console_app_configuration` | `object` | — | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `style_mobile` | `object` | — | | `title` | `string` | The title of the app.Example `My App` | | `logout_url` | `string (uri)` | The logout URL. The user will land on this page when logout is requested by the app.Example `https://staircase.co` | | `access_app_name` | `string` | Access application name. This will be passed to custom auth app via query arguments. Required, when custom auth app is enabled.Example `Staircase` | | `popup` | `object` | Popup layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `left_sidebar` | `object` | Left sidebar layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `right_sidebar` | `object` | Right sidebar layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `header` | `object` | Header layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `hero` | `object` | Hero layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `footer` | `object` | Footer layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `main`required | `object` | Main layout schema. | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `title` | `string` | The title of the app.Example `My App` | | `rendering_type` | `string` | Rendering strategy applied to `console_app_configurations`.`flow``list`Example `flow` | | `console_app_configurations` | `array` | The sequence of apps. | | `change_reload_url_params` | `object` | Dictionary of URL parameters that will be passed as URL query paramerters to `on_change_reload`. Maximum 3 properties can be added. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the main app.Example `true` | | `path_mappings` | `array` | Path mappings configuration. | | `workflows` | `array` | Workflows configuration. | | `error_pages` | `object` | Error pages schema. | | `forbidden` | `object` | Error page schema. | | `page_content`required | `string` | Error page content in HTMLExample `Oops! Something went wrong. Please, refresh or make sure you're accessing this site from the US.
` | | `cookie_consent` | `object` | Cookie consent schema. | | `popup` | `object` | Cookie consent popup schema. | | `title` | `string` | Cookie consent popup title.Example `Cookie consent` | | `short_text` | `string` | Cookie consent popup short text.Example `We use cookies to improve your experience on our website.` | | `button_ok` | `string` | Cookie consent popup OK button text.Example `OK` | | `button_manage_preferences` | `string` | Cookie consent popup manage preferences button text.Example `Manage preferences` | | `preference_center` | `object` | Cookie consent preference center schema. | | `button_save_preferences` | `string` | Cookie consent preference center save preferences button text.Example `Save preferences` | | `title` | `string` | Cookie consent preference center title.Example `Cookie consent` | | `privacy_policy_url` | `string (uri)` | Privacy policy URL.Example `https://www.staircase.co/privacy-policy` | | `custom_css` | `string` | Custom CSS for the cookie consent popup.Example `body { background-color: #000; }` | | `browser_cookie_domain` | `string` | Browser cookie domain.Example `staircase.co` | | `browser_cookie_expiration_days` | `integer` | Cookie expiration in days.Example `365` | | `open_graph_tags` | `object` | Open Graphs tags schema. | | `title`required | `string` | Open Graphs tags title.Example `Staircase` | | `description`required | `string` | Open Graphs tags description.Example `Staircase is a platform for building and deploying web applications.` | | `image`required | `string (uri)` | Open Graphs tags image.Example `https://cdn.edge.staircaseapi.com/media/si_oi9ju8hy7t627892iju4872h4ucnhwebf32eicmcmji349mmc33im3/favicon-dark.ico` | | `type`required | `string` | Open Graphs tags type.`website`Example `website` | | `url`required | `string (uri)` | Open Graphs tags URL.Example `https://www.staircase.co` | | `site_name`required | `string` | Open Graphs tags site name.Example `Staircase` | | `locale`required | `string` | Open Graphs tags locale.`en_US`Example `en_US` | | `backend` | `object` | Backend configuration schema. | | `domain_name` | `string` | Domain name of the backend.Example `service.staircase.co` | ##### Response `201``application/json` 10 fields Success | Field | Type | Description | | --- | --- | --- | | `site_flow_configuration_id` | `string` | The ID of the site configuration.Example `15a820a6-cac9-4b-a7b1-d364b26d7f69` | | `site_flow_product_id` | `string` | The ID of the site flow product.Example `6c5f392f-1ee7-41-9a3d-3b2d08b954fd` | | `analytics` | `object` | Analytics configuration. | | `google_analytics_tag` | `string` | Google Analytics tag.Example `G-A1BCD2EF3H` | | `google_analytics_server_url` | `string` | Google Analytics Container Server URL.Example `https://ss-tagging.moore-dev.staircaseapi.com` | | `advertiser_correlation_key` | `string` | Advertiser correlation key.`utm_source`Example `utm_source` | | `mouseflow_project_identifier` | `string` | Mouseflow project identifier.Example `0710f46a-9441-11ee-8acf-6ae56c4923a6` | | `google_analytics_tracking_parameters` | `string[]` | List of GA custom tracking parameters. | | `facebook_pixel_id` | `string` | Facebook pixel ID.Example `1234567890123456` | | `facebook_pixel_domain_verification` | `string` | Facebook tracking domain name verification to be put in meta head tag.Example `1234567890123456` | | `google_tag_manager_id` | `string` | Google Tag Manager ID.Example `GTM-123456` | | `layout_configuration` | `object` | Site layout configuration. | | `favicon` | `object` | Favicon schema. | | `blob_id` | `string` | Blob identifier from Persistence.Example `01H0JANT98QNERDF7EV0S2JJJJ` | | `blob_url`required | `string` | Blob URL.Example `https://cdn.edge.staircaseapi.com/media/si_oi9ju8hy7t627892iju4872h4ucnhwebf32eicmcmji349mmc33im3/favicon-dark.ico` | | `authentication` | `object` | Authentication schema. | | `enabled` | `boolean` | Whether authentication is enabled.Example `true` | | `show_authentication_on_load` | `boolean` | Should the authentication immediately on site load, default TrueExample `true` | | `console_app_configuration` | `object` | — | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `style_mobile` | `object` | — | | `title` | `string` | The title of the app.Example `My App` | | `logout_url` | `string (uri)` | The logout URL. The user will land on this page when logout is requested by the app.Example `https://staircase.co` | | `access_app_name` | `string` | Access application name. This will be passed to custom auth app via query arguments. Required, when custom auth app is enabled.Example `Staircase` | | `popup` | `object` | Popup layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `left_sidebar` | `object` | Left sidebar layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `right_sidebar` | `object` | Right sidebar layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `header` | `object` | Header layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `hero` | `object` | Hero layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `footer` | `object` | Footer layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `main`required | `object` | Main layout schema. | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `title` | `string` | The title of the app.Example `My App` | | `rendering_type` | `string` | Rendering strategy applied to `console_app_configurations`.`flow``list`Example `flow` | | `console_app_configurations` | `array` | The sequence of apps. | | `change_reload_url_params` | `object` | Dictionary of URL parameters that will be passed as URL query paramerters to `on_change_reload`. Maximum 3 properties can be added. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the main app.Example `true` | | `path_mappings` | `array` | Path mappings configuration. | | `workflows` | `array` | Workflows configuration. | | `error_pages` | `object` | Error pages schema. | | `forbidden` | `object` | Error page schema. | | `page_content`required | `string` | Error page content in HTMLExample `Oops! Something went wrong. Please, refresh or make sure you're accessing this site from the US.
` | | `cookie_consent` | `object` | Cookie consent schema. | | `popup` | `object` | Cookie consent popup schema. | | `title` | `string` | Cookie consent popup title.Example `Cookie consent` | | `short_text` | `string` | Cookie consent popup short text.Example `We use cookies to improve your experience on our website.` | | `button_ok` | `string` | Cookie consent popup OK button text.Example `OK` | | `button_manage_preferences` | `string` | Cookie consent popup manage preferences button text.Example `Manage preferences` | | `preference_center` | `object` | Cookie consent preference center schema. | | `button_save_preferences` | `string` | Cookie consent preference center save preferences button text.Example `Save preferences` | | `title` | `string` | Cookie consent preference center title.Example `Cookie consent` | | `privacy_policy_url` | `string (uri)` | Privacy policy URL.Example `https://www.staircase.co/privacy-policy` | | `custom_css` | `string` | Custom CSS for the cookie consent popup.Example `body { background-color: #000; }` | | `browser_cookie_domain` | `string` | Browser cookie domain.Example `staircase.co` | | `browser_cookie_expiration_days` | `integer` | Cookie expiration in days.Example `365` | | `open_graph_tags` | `object` | Open Graphs tags schema. | | `title`required | `string` | Open Graphs tags title.Example `Staircase` | | `description`required | `string` | Open Graphs tags description.Example `Staircase is a platform for building and deploying web applications.` | | `image`required | `string (uri)` | Open Graphs tags image.Example `https://cdn.edge.staircaseapi.com/media/si_oi9ju8hy7t627892iju4872h4ucnhwebf32eicmcmji349mmc33im3/favicon-dark.ico` | | `type`required | `string` | Open Graphs tags type.`website`Example `website` | | `url`required | `string (uri)` | Open Graphs tags URL.Example `https://www.staircase.co` | | `site_name`required | `string` | Open Graphs tags site name.Example `Staircase` | | `locale`required | `string` | Open Graphs tags locale.`en_US`Example `en_US` | | `backend` | `object` | Backend configuration schema. | | `domain_name` | `string` | Domain name of the backend.Example `service.staircase.co` | ##### Other responses `400``422` `GET` `/ordered-flows/{site_flow_configuration_id}` #### View Configuration `getAppConfiguration` #### View Configuration Retrieves the definition. ##### Response 200400404 application/json Copy Success ``` { "site_flow_configuration_id": "345e8795-eb14-24t3-a2-aaaa174000", "site_flow_product_id": "345e8795-eb14-24t3-a2-aaaa174001", "layout_configuration": { "authentication": { "enabled": false }, "left_sidebar": { "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174002", "temporary__console_app_url": "/left-sidebar-url", "style": { "width": "250px", "height": "100%" } }, "header": { "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174003", "temporary__console_app_url": "/header-url", "style": { "width": "100%", "height": "50px" } }, "hero": { "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174013", "temporary__console_app_url": "/hero-url", "style": { "width": "100%", "height": "50px" } }, "footer": { "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174004", "temporary__console_app_url": "/footer-url", "style": { "width": "100%", "height": "30px" } }, "main": { "title": "My website", "style": { "width": "100%", "height": "80px", "padding": "10px 20px" }, "rendering_type": "flow", "console_app_configurations": [ { "title": "Credentials", "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174006", "temporary__console_app_url": "/app1", "url_suffix": "/credentials" }, { "title": "Configuration Settings", "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174007", "temporary__console_app_url": "/app2", "url_suffix": "/configuration-settings" }, { "title": "Partner Options", "console_app_configuration_id": "345e8795-eb14-24t3-a2-aaaa174008", "temporary__console_app_url": "/app3", "url_suffix": "/partner-options" } ] } } } ``` application/json Copy A 400 status code occurs when some of provided request parameters is invalid. ``` { "error": { "message": "Bad Request", "reason": "Provided token is not valid." } } ``` application/json Copy A 404 status code occurs when a requested resource cannot be located. ``` { "error": { "message": "Not found.", "reason": "Flow(site_flow_configuration_id=`345e8795-eb14-24t3-a2-aaaa174000`)" } } ``` ##### Parameters 1 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `site_flow_configuration_id` required | `string` path | `15a820a6-cac9-4b-a7b1-d364b26d7f69` | Site flow configuration ID. | ##### Response `200``application/json` 10 fields Success | Field | Type | Description | | --- | --- | --- | | `site_flow_configuration_id` | `string` | The ID of the site configuration.Example `15a820a6-cac9-4b-a7b1-d364b26d7f69` | | `site_flow_product_id` | `string` | The ID of the site flow product.Example `6c5f392f-1ee7-41-9a3d-3b2d08b954fd` | | `analytics` | `object` | Analytics configuration. | | `google_analytics_tag` | `string` | Google Analytics tag.Example `G-A1BCD2EF3H` | | `google_analytics_server_url` | `string` | Google Analytics Container Server URL.Example `https://ss-tagging.moore-dev.staircaseapi.com` | | `advertiser_correlation_key` | `string` | Advertiser correlation key.`utm_source`Example `utm_source` | | `mouseflow_project_identifier` | `string` | Mouseflow project identifier.Example `0710f46a-9441-11ee-8acf-6ae56c4923a6` | | `google_analytics_tracking_parameters` | `string[]` | List of GA custom tracking parameters. | | `facebook_pixel_id` | `string` | Facebook pixel ID.Example `1234567890123456` | | `facebook_pixel_domain_verification` | `string` | Facebook tracking domain name verification to be put in meta head tag.Example `1234567890123456` | | `google_tag_manager_id` | `string` | Google Tag Manager ID.Example `GTM-123456` | | `layout_configuration` | `object` | Site layout configuration. | | `favicon` | `object` | Favicon schema. | | `blob_id` | `string` | Blob identifier from Persistence.Example `01H0JANT98QNERDF7EV0S2JJJJ` | | `blob_url`required | `string` | Blob URL.Example `https://cdn.edge.staircaseapi.com/media/si_oi9ju8hy7t627892iju4872h4ucnhwebf32eicmcmji349mmc33im3/favicon-dark.ico` | | `authentication` | `object` | Authentication schema. | | `enabled` | `boolean` | Whether authentication is enabled.Example `true` | | `show_authentication_on_load` | `boolean` | Should the authentication immediately on site load, default TrueExample `true` | | `console_app_configuration` | `object` | — | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `style_mobile` | `object` | — | | `title` | `string` | The title of the app.Example `My App` | | `logout_url` | `string (uri)` | The logout URL. The user will land on this page when logout is requested by the app.Example `https://staircase.co` | | `access_app_name` | `string` | Access application name. This will be passed to custom auth app via query arguments. Required, when custom auth app is enabled.Example `Staircase` | | `popup` | `object` | Popup layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `left_sidebar` | `object` | Left sidebar layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `right_sidebar` | `object` | Right sidebar layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `header` | `object` | Header layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `hero` | `object` | Hero layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `footer` | `object` | Footer layout schema. | | `console_app_configuration_id` | `string` | The ID of the console app configuration.Example `4ed4be4e-4c4e-42-af36-7928d3e1c9ac` | | `temporary__console_app_url` | `string (uri)` | The temporary URL of the console app.Example `/app/4ed4be4e-4c4e-4f72-af36-7928d3e1c9ac` | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `main`required | `object` | Main layout schema. | | `style` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `style_mobile` | `object` | — | | `width` | `string` | The width of an element.Example `100%` | | `height` | `string` | The height of an element.Example `50px` | | `padding` | `string` | The padding of an element.Example `10px 20px` | | `margin` | `string` | The margin of an element.Example `5px` | | `display` | `string` | Display value of element.`flex``none`Example `flex` | | `on_change_reload` | `string[]` | The locations to reload when the app changes. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the layout placeholder app.Example `true` | | `title` | `string` | The title of the app.Example `My App` | | `rendering_type` | `string` | Rendering strategy applied to `console_app_configurations`.`flow``list`Example `flow` | | `console_app_configurations` | `array` | The sequence of apps. | | `change_reload_url_params` | `object` | Dictionary of URL parameters that will be passed as URL query paramerters to `on_change_reload`. Maximum 3 properties can be added. | | `inherit_url_path` | `boolean` | Pass url_path from Site to the main app.Example `true` | | `path_mappings` | `array` | Path mappings configuration. | | `workflows` | `array` | Workflows configuration. | | `error_pages` | `object` | Error pages schema. | | `forbidden` | `object` | Error page schema. | | `page_content`required | `string` | Error page content in HTMLExample `Oops! Something went wrong. Please, refresh or make sure you're accessing this site from the US.
` | | `cookie_consent` | `object` | Cookie consent schema. | | `popup` | `object` | Cookie consent popup schema. | | `title` | `string` | Cookie consent popup title.Example `Cookie consent` | | `short_text` | `string` | Cookie consent popup short text.Example `We use cookies to improve your experience on our website.` | | `button_ok` | `string` | Cookie consent popup OK button text.Example `OK` | | `button_manage_preferences` | `string` | Cookie consent popup manage preferences button text.Example `Manage preferences` | | `preference_center` | `object` | Cookie consent preference center schema. | | `button_save_preferences` | `string` | Cookie consent preference center save preferences button text.Example `Save preferences` | | `title` | `string` | Cookie consent preference center title.Example `Cookie consent` | | `privacy_policy_url` | `string (uri)` | Privacy policy URL.Example `https://www.staircase.co/privacy-policy` | | `custom_css` | `string` | Custom CSS for the cookie consent popup.Example `body { background-color: #000; }` | | `browser_cookie_domain` | `string` | Browser cookie domain.Example `staircase.co` | | `browser_cookie_expiration_days` | `integer` | Cookie expiration in days.Example `365` | | `open_graph_tags` | `object` | Open Graphs tags schema. | | `title`required | `string` | Open Graphs tags title.Example `Staircase` | | `description`required | `string` | Open Graphs tags description.Example `Staircase is a platform for building and deploying web applications.` | | `image`required | `string (uri)` | Open Graphs tags image.Example `https://cdn.edge.staircaseapi.com/media/si_oi9ju8hy7t627892iju4872h4ucnhwebf32eicmcmji349mmc33im3/favicon-dark.ico` | | `type`required | `string` | Open Graphs tags type.`website`Example `website` | | `url`required | `string (uri)` | Open Graphs tags URL.Example `https://www.staircase.co` | | `site_name`required | `string` | Open Graphs tags site name.Example `Staircase` | | `locale`required | `string` | Open Graphs tags locale.`en_US`Example `en_US` | | `backend` | `object` | Backend configuration schema. | | `domain_name` | `string` | Domain name of the backend.Example `service.staircase.co` | ##### Other responses `400``404` `POST` `/event-loop/poll/{site_flow_configuration_id}` #### Check Session `pollSessionProgress` This endpoint generates a new session and transaction IDs, Session ID is used to differentiate between different sessions of the same user who is coming from the same resource, and possibly several times. This API is an entrypoint for the shell application of the Site to start the communication with the backend Site. #### Authentication If the configuration has the authentication enabled, the Site will perform soft-validation of the user and store email address of the person logging in. The email address will be stored in the `person[0].email_address`. Show the rest Site checks for `email_address` and `custom:person_identifier` JWT claims to find user's email address and GUID. Later on, Site will populate transaction (marked by `transaction_id`) with the email address of the user signed in. Site populates the transaction in a synchronous manner, i.e., the transaction will be populated before the response is returned. #### Advertiser Key Correlation When the website is set up with the advertiser key linkage, it will search for the correlating key within query parameters of the URL. This key should be present in the query parameters and its value should correspond to the advertiser's ID. If a prior session is already in place, the website will bypass both the correlating key and the associated advertisement information. If not, the website will initiate a new session, and the advertisement details will be stored under this fresh transaction, which is marked by a `transaction_id`. ##### Example Define the advertiser key correlation key in the configuration: ``` { "analytics": { "advertiser_correlation_key": "utm_source" }, "layout_configuration": {...} } ``` Set the URL in the advertisement platform (e.g. Google Ads) to include the correlating key: ``` ``` Here the correlating key is `utm_source` and the value is `91319ebc-3c29-4e65-801c-91d4e32073a5`, which represents the advertiser's ID. ##### Response 200400404 application/json Copy Successfully retrieved the current app ID ``` { "transaction_id": "5aa4be4e-4c4e-42-af36-9ddaaa2322ec", "session_id": "6ed4be4e-4c4e-42-af36-9ddaaa2322ec", "trace_id": "OOWDANFA" } ``` application/json Copy A 400 status code occurs when some of provided request parameters is invalid. ``` { "error": { "message": "Bad Request", "reason": "Provided token is not valid." } } ``` application/json Copy A 404 status code occurs when a requested resource cannot be located. ``` { "error": { "message": "Not found.", "reason": "Flow(site_flow_configuration_id=`345e8795-eb14-24t3-a2-aaaa174000`)" } } ``` ##### Parameters 5 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-sc-trace-id` required | `string` header | `01HQQEHAPB8EVDA35QDTMEEV9X` | The trace ID | | `site_flow_configuration_id` required | `string` path | `15a820a6-cac9-4b-a7b1-d364b26d7f69` | Site flow configuration ID. | | `session_id` | `string` query | `5ed4be4e-4c4e-42-af36-9ddaaa2322ec` | An existing session ID (optional) | | `transaction_id` | `string` query | `5aa4be4e-4c4e-42-af36-9ddaaa2322ec` | An existing transaction ID associated with the session ID (optional) | | `Authorization` | `string` header | `400 Bad Request
400 Bad Request
`. Site will automatically upload images and modify the image paths to point to the correct URL. ! Note: You should avoid using spaces at your content name
#### Product Quick Start Guides
Detailed guide of how-to attach product Quick Start Guides under the product bundle
#### Links to custom files
Any downloadable file you want to serve in overview page should be placed to product repo /requirements/public folder. They can be referenced in the overview file like `Link Text`. Site will automatically upload the files and modify the path to point to the correct URL.
##### Left-Hand Navigation Sidebar
The left-hand navigation sidebar for api.staircase.co is automatically built based on custom extensions in the product’s swagger file. Every swagger file needs these 3 custom extensions added after the “title” property. You only need to specify these extensions once per swagger file.
- `x-product-family:` family the product should be listed under
- `x-product-category:` category the product should be listed under
- `x-product-name:` product name.
Every endpoint within the swagger file needs these 3 custom extensions added after the “path” property:
- `x-product-component:` the name of the component under which the endpoint should be grouped
- `x-product-endpoint:` the name of the endpoint
- `x-product-sequence:` the sequence in which the endpoint should appear under the component.
Both: `x-product-component` and/or `x-product-endpoint` can be defined as:
- `x-product-*: value[new]` it will add "NEW" pill to the x-product-*
- `x-product-*: value[deprecated]` it will add "DEPRECATED" pill to the x-product-*
- `x-product-*: value[warning]` it will add "WARNING" pill to the x-product-*
- `x-product-*: value[updated]` it will add "UPDATED" pill to the x-product-*
! Note: `x-product-*` value at Technical Site will not contain `[*pill*]` text while rendering. It will render pill instead.
##### Multiple Swagger Files for One Product
To publish multiple swagger files to the same product, make sure that the x-product-name extension in every repo’s swagger file must be given the same product name. For example, if the “Tax” product is associated with 5 different swagger files and repos, every swagger file/repo must provide the name “Tax” as x-product-name.
The product name must match a product name in the product ontology.
##### Request
application/json Copy
```
{
"artifact_url": "https://dev-marketplace-bundles-bucket-us-east-1-581813358386.s3.amazonaws.com/SERVICE/Automated%20Underwriting%20System%20%28AUS%29/01G110WHPJFCGMD0YHF8G6PAKB?AWSAccessKeyId=400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
\n
\n" } ] ``` text/html Copy Bad Request ``` \r\n400 Bad Request
` | ##### Response `400``application/json` 2 fields Bad Request | Field | Type | Description | | --- | --- | --- | | `error` | `string` | Error. | | `message` | `string` | Error message. | ##### Response `404``application/json` 1 fields Publishing not found. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message which contains information about requested entity | ##### Response `500``application/json` 1 fields Server error | Field | Type | Description | | --- | --- | --- | | `error`required | `string` | Error message. | ##### Response `502``application/json` 1 fields Server error | Field | Type | Description | | --- | --- | --- | | `error` | `string` | Error message. | ##### Other responses `403` `POST` `/tech/products/{product_name}/quickstart-guides` #### Add Quick Start Guide `postQuickStartGuide` Add Quick Start Guide #### Attaching Quick Start Guides via bundle Site platform is able to parse Quick Start Guides from your bundle automatically. To get your Quick Start Guides be parsed from your bundle, just create the following structure: ``` /requirements/quick-start-guides/dictionary.json /requirements/quick-start-guides/guide1.md /requirements/quick-start-guides/guide2.md ...etc ``` /requirements/quick-start-guides/dictionary.json Show the rest This file contains your Quick Start Guides descriptions, names and paths to MD files. Example: ``` { "guide_1_name": { "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam.", "path": "guide1.md" }, "guide_2_name": { "description": "Quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.", "path": "guide2.md" } } ``` ! Note: Quick Start Guide Definition can accept an images/custom files described at Site: Publish Artifact endpoint. ! Note: Custom Files/images should be present under the same product name as Quick Start Guide ##### Request application/json Copy ``` { "name": "How to publish documentation via pipeline", "description": "Complete how-to...", "type": "markdown", "data": "\n
\n
\n" } ``` ##### Response 201400 application/json Copy Example response ``` { "id": "0944f479-3b23-4a9e-b193-b3df37825525" } ``` text/html Copy Bad Request ``` \r\n400 Bad Request
\n
\n" } ``` text/html Copy Bad Request ``` \r\n400 Bad Request
` | ##### Response `400``application/json` 2 fields Bad Request | Field | Type | Description | | --- | --- | --- | | `error` | `string` | Error. | | `message` | `string` | Error message. | ##### Response `404``application/json` 1 fields Publishing not found. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message which contains information about requested entity | ##### Response `500``application/json` 1 fields Server error | Field | Type | Description | | --- | --- | --- | | `error`required | `string` | Error message. | ##### Response `502``application/json` 1 fields Server error | Field | Type | Description | | --- | --- | --- | | `error` | `string` | Error message. | ##### Other responses `403` `PUT` `/tech/products/{product_name}/quickstart-guides/{quickstart_guide_id}` #### Update Quick Start Guide `putQuickStartGuide` Update Quick Start Guide ##### Request application/json Copy ``` { "name": "How to publish documentation via pipeline", "description": "Complete how-to...", "type": "markdown", "data": "\n
\n
\n" } ``` ##### Response 201400 application/json Copy Example response ``` { "id": "0944f479-3b23-4a9e-b193-b3df37825525" } ``` text/html Copy Bad Request ``` \r\n400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
400 Bad Request
\n
\n" } ``` text/html Copy Bad Request ``` \r\n400 Bad Request
` | ##### Response `400``application/json` 2 fields Bad Request | Field | Type | Description | | --- | --- | --- | | `error` | `string` | Error. | | `message` | `string` | Error message. | ##### Response `404``application/json` 1 fields Publishing not found. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message which contains information about requested entity | ##### Response `500``application/json` 1 fields Server error | Field | Type | Description | | --- | --- | --- | | `error`required | `string` | Error message. | ##### Response `502``application/json` 1 fields Server error | Field | Type | Description | | --- | --- | --- | | `error` | `string` | Error message. | ##### Other responses `403` `POST` `/tech/products/{product_name}/components/{component_name}/overview` #### Add Component Overview Page `postComponentOverviewPage` Add Component Overview Page. ##### Request application/json Copy ``` { "overview": "" } ``` ##### Response 200400 application/json Copy Success response ``` { "overview_embedded": "\n
\n
\n" } ``` text/html Copy Bad Request ``` \r\n400 Bad Request
` | ##### Response `400``application/json` 2 fields Bad Request | Field | Type | Description | | --- | --- | --- | | `error` | `string` | Error. | | `message` | `string` | Error message. | ##### Response `404``application/json` 1 fields Publishing not found. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message which contains information about requested entity | ##### Response `422``application/json` 1 fields Bad request. | Field | Type | Description | | --- | --- | --- | | `error` | `string` | Error message. | ##### Response `500``application/json` 1 fields Server error | Field | Type | Description | | --- | --- | --- | | `error`required | `string` | Error message. | ##### Response `502``application/json` 1 fields Server error | Field | Type | Description | | --- | --- | --- | | `error` | `string` | Error message. | ##### Other responses `403` `GET` `/tech/products/{product_name}/overview` #### Get Overview Page `getOverviewEmbedded` Get overview Page Get product overview page HTML content. ##### Response 200400 application/json Copy Success response ``` { "overview_embedded": "\n
\n
\n" } ``` text/html Copy Bad Request ``` \r\n400 Bad Request
` | ##### Response `400``application/json` 2 fields Bad Request | Field | Type | Description | | --- | --- | --- | | `error` | `string` | Error. | | `message` | `string` | Error message. | ##### Response `404``application/json` 1 fields Publishing not found. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message which contains information about requested entity | ##### Response `500``application/json` 1 fields Server error | Field | Type | Description | | --- | --- | --- | | `error`required | `string` | Error message. | ##### Response `502``application/json` 1 fields Server error | Field | Type | Description | | --- | --- | --- | | `error` | `string` | Error message. | ##### Other responses `403` `POST` `/tech/products/{product_name}/overview` #### Add Overview Page `postOverviewPage` Add Product Overview Page. ##### Request application/json Copy ``` { "overview": "" } ``` ##### Response 200400 application/json Copy Success response ``` { "overview_embedded": "\n
\n
\n" } ``` text/html Copy Bad Request ``` \r\n400 Bad Request
` | ##### Response `400``application/json` 2 fields Bad Request | Field | Type | Description | | --- | --- | --- | | `error` | `string` | Error. | | `message` | `string` | Error message. | ##### Response `404``application/json` 1 fields Publishing not found. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message which contains information about requested entity | ##### Response `422``application/json` 1 fields Bad request. | Field | Type | Description | | --- | --- | --- | | `error` | `string` | Error message. | ##### Response `500``application/json` 1 fields Server error | Field | Type | Description | | --- | --- | --- | | `error`required | `string` | Error message. | ##### Response `502``application/json` 1 fields Server error | Field | Type | Description | | --- | --- | --- | | `error` | `string` | Error message. | ##### Other responses `403` ### Tech: Logo[new] `GET` `/tech/logo` #### Get Logo `getLogo` Get Logo download URL used both Sites: Technical and Marketing. ##### Response 200400 application/json Copy Logo URL ``` { "download_url": "https://documentation.staircaseapi.com/products/Site/content/public/logo.png" } ``` text/html Copy Bad Request ``` \r\n