Pages represent different landing points of your customers on your Tebex store. For example, when customers visit a category on your store, the category.html page will be rendered. For this reason, pages must be implemented in your templates and cannot be deleted (unlike Assets).

If you'd like access to a variable that is not currently available, please let us know.

The only pages that are not accessible to the public are the following:

The index.html page is the homepage of your store.

Root Object

Request Variable

If you'd like access to a variable that is not currently available, please let us know.

The username.html page is responsible for allowing your customers login to your store.

Root Object

External Login

If the external variable is true, let the user click a link to proceed to login via the external login provider:

<p>Please login with your {{ provider }} account to continue.</p>
<a href="{{ url }}">Login</a>

Non-External Login

If the external variable is false, provide a form submitting to the current url, including an ign form parameter. The ign parameter should be a text field allowing the customer to enter their username freehand.

An example can be seen below:

<form method="post">
    <input type="text" name="ign" placeholder="Enter your in-game username" />
    <button type="submit">Login</button>
</form>

Full Working Example

An example of a flow supporting both external and non-external login providers is shown below:

{% if external %}
    <a href="{{ url }}">Login via {{ provider }}</a>
{% else %}
    <form method="post">
        <input
            type="text"
            name="ign"
            placeholder="Enter your in-game username"
        />
        <button type="submit">Login</button>
    </form>
{% endif %}

Request Variable

If you'd like access to a variable that is not currently available, please let us know.

The package.html page displays details about a specific package on your store.

Root Object

Request Variable

If you'd like access to a variable that is not currently available, please let us know.

The cms/page.html page displays any that you have created on your store.

Root Object

Request Variable

If you'd like access to a variable that is not currently available,

There isn't any specific variables for layout.html. This page is usually extended by all other pages, providing your stores base layout structure.

An example of using layout.html can be seen below:

layout.html

checkout.html

The options.html page is shown to the customer when adding a package that requires customisation, such as when you are using .

Root Object

Package Object

Variable Object

Variable Option Object

Request Variable

There is no specific variables for checkout.html. All checkout functionality is handled via opening a new session. To start a new Checkout session, you should do the following:

Receive an ident for Tebex.js

GET /checkout/ident

This endpoint will return an ident for the current basket, which is required by when launching a checkout modal.

Response

Using Tebex.js

To learn how to add Tebex.js to your store, please view the or view the demo over at .

The category.html page lists the that are available to purchase in the current category being viewed on your store.

Root Object

Request Variable

If you'd like access to a variable that is not currently available,