Welcome to your journey of launching your first project with Tebex! This guide will walk you through the essential steps to create, set up, and launch your store, ensuring a seamless experience for your customers. From building your first project in the creator panel to implementing automatic product delivery, we'll cover everything you need to know to get started.

Welcome to the Tebex developer documentation. If you're new, start with our or explore one of our products below. If you need assistance during the integration process, don’t hesitate to - we’re here to help.

Package slugs allow you to customize your package's URL slug for better readability.

If you are using a custom template, you may need to update it to ensure the package slugs feature functions correctly on your webstore.

Template Changes

In your Twig templates, any instance of package.id should be updated to package.identifier. This property will use the package’s slug if available and default to the numeric ID if not.

The best way to understand the functionality of the Tebex templating engine is to create a copy of our default template, named Exo.

You can do this by navigating to Webstore -> Appearance in your control panel and creating a custom template based on Exo.

For a live demonstration of Exo in action, visit .

If you're a template developer, you're entitled to receive free Tebex Plus to enable you to freely develop templates for your clients. Stores that receive our developer plan won't be able to transact real payments on their store.

You're also eligible to gain access to the certified Tebex designers club. You'll get insider help guides, access to a private community of other elite designers, feedback sessions with the Tebex product team, and also BETA features that are not yet available to others.

If you'd like to apply to become a Tebex Certified Designer, .

Gifting a Package to Another Player

You can allow players to gift packages to other players. Include target_username_id , or target_username when adding the package to the basket and the package will be delivered to that player rather than the buyer.

Gifting Example

The target_username_id should be a unique identifier for the player instead of their name (such as a Minecraft UUID or Steam ID):

If offered by your store, you can apply coupons, gift cards, and creator codes via Headless API once a basket has been created and the user's desired packages have been added.

The Overwolf Subscriptions API enables developers to seamlessly integrate subscription-based monetization into their Overwolf apps using a Tebex Store. This integration provides a complete subscription management system - removing the need to handle payment processing, track subscription statuses, or build complex server-side infrastructure.

Get Started with Overwolf App Monetization

Before implementing subscriptions, review Overwolf’s documentation to understand the available monetization options and how to incorporate them into your app.

Learn more: Overwolf App Monetization Guide

This guide covers:

• Supported monetization models in Overwolf

• How Tebex integrates into the Overwolf ecosystem

• Steps for setting up and linking your Tebex Store

Explore the Overwolf Subscriptions API Reference

The Overwolf Subscriptions API provides all the endpoints and methods you’ll need to manage your users’ subscriptions through Tebex. It includes details on authentication, subscription lifecycle management, and user entitlement verification.

View the full API documentation: Overwolf Subscriptions API Reference

Use this reference to:

• Fetch active subscriptions for users

• Verify subscription status within your app

• Manage user access based on entitlement data

Review the Example App

To see a working implementation, Overwolf provides an example application demonstrating how to use the Tebex Subscriptions API in a sample application.

Explore the sample app on GitHub: Tebex Subscriptions Example App

This repository includes:

• End-to-end integration examples

• Code samples for handling subscription data

• Reference architecture for production deployments

Templates on the Tebex platform are written in the Twig Templating Engine. Twig allows you to customise your store with control structures, similar to any other language, while maintaining a sandboxed and safe environment for the Tebex infrastructure.

You're able to learn more information about the syntax of Twig by viewing the official documentation.

A common Twig file may look like the following:

<!DOCTYPE html>
<html>
    <head>
        <title>My Webpage</title>
    </head>
    <body>
        <ul id="navigation">
        {% for item in navigation %}
            <li><a href="{{ item.href }}">{{ item.caption }}</a></li>
        {% endfor %}
        </ul>

        <h1>My Webpage</h1>
        {{ a_variable }}
    </body>
</html>

Global variables are variables which are available across all pages of your store.

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

The global store object contains all information associated with the project itself, such as store name.

Request Variable

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

The global page object contains variables associated with the current http request.

Request Variable

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

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.

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

<!DOCTYPE html>
<html>
    <body>
        {% block content %}{% endblock %} {# The content of checkout.html will be shown #}
    </body>
</html>

checkout.html

{% extends "layout.html" %}

{% block content %}
    Hello, world!
{% endblock %}

The gift card balance module lets your customers enter a gift card and determine the amount of value that remains on the specified gift card.

Request Variable

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

The server status module allows creators who operate Game Servers to display the status of their game server (e.g. player count or online status) on their store.

Request Variable

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

The top donator module allows you to display the highest spending customer on your store.

Request Variable

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

Assets allow you to upload your own CSS, Javascript, Images or Twig files to your template, which you can later reference in your files.

To create an asset, first upload it from within the template editor. Once you have uploaded the asset, you can retrieve the public URL of the asset by using theasset() function. This function will return the full URL of the asset hosted on our global CDN.

For example, you could upload scripts.js as an asset, and then include it in your template:

<script defer src="{{ asset('scripts.js') }}"></script>

You're also able to create TWIG files that you can later reference in your template. For example, you could create an asset called navigation.twig, and then include it using the Twig include tag:

{% include "navigation.twig" %}

This allows you to create code that is easily reusable across multiple locations in your template.

In order to support certain features of Tebex, your custom template must be kept up-to-date. Please see the following guides:

If you’re using a custom or legacy store template, you may not see all package images (when multiple images are uploaded) or the package video.

If you are using the Exo template, this guide does not apply.

Older templates relied on the package.image property to display a package’s image URL. To support package media properly, you now need to use the new package.media array instead. See the example code snippet below demonstrating how to use the new media array.

{% for media in package.media %}
  <div class="slide">
    {% if media.type == 'image' %}
      <img
        class="slide-image"
        src="{{ media.url }}"
        alt="{{ package.name }}"
      />
    {% elseif media.type == 'video' %}
      <iframe
        class="slide-frame"
        src="https://www.youtube.com/embed/{{ media.url }}?color=white&amp;rel=0"
        title="YouTube video player"
        frameborder="0"
        allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
        referrerpolicy="strict-origin-when-cross-origin"
        allowfullscreen
      ></iframe>
    {% endif %}
  </div>
{% endfor %}

We've built an open-source SDK for Unreal Engine 5 that provides everything needed to quickly start integrating with Tebex:

• C++ mappings for Headless API

• C++ mappings for the Plugin API

• An example in-game Plugin

GitHub Repository: tebexio/Tebex-UE5

When you're ready to start processing payments for your Unreal game, we’d love to connect. Reach out to us to get started.

Modules allow you to add dynamic modules on your store, which you can configure from within your creator panel on the sidebar section.

Each modules HTML is configurable in their associated module.*.html page (documented onwards).

You can display the modules on your store by printing the modules variable, as seen below:

{{ modules|raw }}

To access the Plugin API, all requests need to be authenticated via a Game Server secret key which is found in the game servers section of your creator panel.

Supply the secret key by setting the X-Tebex-Secret header in all requests to the API.

If you don't wish to use a popup, you can choose to render the checkout to an element within your page. To do this, use Tebex.checkout.render() instead of Tebex.checkout.launch():

Tebex.checkout.init({
    ident: "your checkout request ident goes here",
});

Tebex.checkout.render(
    // The element to render to
    document.getElementById("some-element");
    // The width of the checkout iframe, in pixels
    500,
    // The height of the checkout iframe, in pixels
    600
    // Boolean indicating whether you want to open a new tab on mobile
    // (defaults to true if unspecified)
    false
);

Your server can receive Webhooks from Tebex after events occur on our platform (successful payment, refunds, etc.)

Please see our Webhooks Overview for a guide on working with Webhooks.

Errors are JSON format and are based around the standard HTTP status codes.

For example when an invalid secret key is provided the HTTP status code 403 Forbidden will be returned along with a JSON body containing further information.

The error_message object will always be user friendly and should be shown directly to the client.

Tags are control structures within Twig. They allow you to change the flow of code within your template.

If you'd like access to a TWIG tag that is not available below, please let us know.

Available Tags

The global basket object contains all information relevant to the customers basket, such as price & packages.

Request Variable

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

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 featured package module allows you to feature a package, bringing more attention to it on your store.

Request Variable

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

When the user is ready to checkout, you can fetch the current basket and direct the user to its links.checkout URL. Here, the user will enter their payment information and complete checkout.

If you'd like the user to stay on your site during checkout, use Tebex.js alongside the Headless API.

Official SDKs

The SDKs below include support for Headless API, Checkout API, and Webhooks, complete with examples, making implementation of these APIs into your project as easy as possible.

OpenAPI Schema

Tebex APIs are documented using OpenAPI. These are used to generate our Endpoints documentation. Our schemas are available at the GitHub repositories below. The OpenAPI Generator can be used to generate an SDK in the language of your choice if we do not have your language available.

Other SDKs / Integration Options

Below are additional resources and projects that can help you implement Tebex into your project. If you've developed an SDK, please reach out to us at [email protected].

We provide our complete C# SDK used to develop our official plugins.

This repository serves as our full Tebex SDK for projects using C#. It is designed to be forked and modified for your particular requirements.

• C# mappings for Headless API

• C# mappings for Plugin API

• An example in-game TebexCorePlugin which implements processing command deliverables on game servers.

GitHub Repositories:

• C# SDK:

• Unity Plugin:

When you're ready to start processing payments for your Unity game, we’d love to connect. to get started.

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 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,

The community goal module displays the current progress of a community goal which you have configured within your creator panel on the section.

Request Variable

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

The goal module allows you to show a goal of how much money you'd like to earn over a specific period.

Request Variable

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

When adding packages, there may be certain Variables associated with them. These can be filled by providing a variable_data object.

Deliverable Types and Variable Data

Gift Card

Packages that deliver a gift card to the user should include giftcard_to mapped to the e-mail address that will receive the gift card:

Discord Action

Packages that deliver Discord actions should include the user's discord_id:

Game Server Commands

Packages that deliver game server commands should include the username_id of the user, dependent on your store type.

You can get the username_id after creating the basket if you provide the player's username at the time of creation. See Creating a Basket for specific details on Game Servers.

Custom Data

You can also provide custom data when adding packages which can be referenced by the seller as part of the transaction.

Specifying the Package's Game Server

If a package with a Game Server Command has the configuration option:

• Allow customers to select the game server they want to receive this package on.

You can specify the target game server in the request by including server_id in your package's variable_data:

A list of your server_ids can be found in your by clicking Edit beside your relevant game server. The server ID is the number at the end of the URL when editing the game server.

All errors returned by the Tebex Checkout APIs follow the RFC 7807 standard ().

We also use standardised HTTP response codes to describe each error:

1. 400 Bad Request - User data validation error

2. 401 / 403 - Authentication / Authorization (depending on if it's pre- or post- authentication

3. 404 - Requested resource doesn't exist

4. 5xx - Server side transitory errors.

The affiliate API enables you to integrate a one-click setup process for Tebex within your server management panel. A one-click setup process has the following benefits:

• Removes the complexity of your customers installing the Tebex Plugin

• Increases conversions which will result in more commission paid into your affiliate account.

• You will receive a percentage of any revenue the server earns from their players.

Integration Example

1. Your customers click Install Tebex within your server management panel.

2. You send an API request to Tebex alerting us of the customers request.

3. We send an email to the customer with a link that allows them to create a webstore.

4. Once the customer has created a webstore we will send you a webhook that contains a download url of the plugin, along with a pre-made plugin config file that includes the customers authentication details (their secret key).

5. You install the provided plugin along with its config file and restart your customers game server.

A typical integration of this API will take a few hours depending on the experience of your development team.

Requirements

Please note that the one-click setup process is only available to approved partners of the Tebex Checkout For Server Hosts program. Please us for any additional questions or application information.

Once your application has been approved, your API key can be found towards the bottom of the .

To ensure you receive JSON responses, please provide an Accept: application/json header with all API requests.

Tebex.js is our solution to enable developers to integrate the checkout experience directly within your own website. Customers do not have to be redirected to an external website, improving conversions and providing a seamless checkout experience.

Demo

You can experience a live demo of Tebex.js by heading over to or taking a look at the gallery below.

Baskets

Category and Package Retrieval

Promotions and Discounts

Adding and Removing Packages

Sidebar

When you are ready to redirect the customer to checkout, there are two ways of beginning the checkout experience:

1. Embedded - via Tebex.js

If you'd like the customer to remain on your website to complete their purchase, you're able to integrate Tebex.js, which is our embeddable checkout experience.

Head over to the to get started.

2. External - via Redirect

You may also redirect the customer to an external checkout window using the following URL:

https://pay.tebex.io/{ident}

This is the same as the links.checkout value in a Basket API response. Where {ident} is the ident value returned when creating the basket.

Sidebar modules showcase additional information from the store. Modules are enabled in the store's configuration/The following modules are supported:

Use the following endpoint to get all enabled sidebar module data:

Module Schemas

You can retrieve your packages & category listings in JSON format and display them however you wish.

Authenticated Requests

Login verification allows you to integrate your own authentication layer into your webstore. Once you have set up player verification the webstore will ping an endpoint hosted on your own website with information about the player attempting to log in. Depending on your response you can deny/allow the customer from logging in.

The login verification system opens up a whole new world of opportunities for integrating with your own backend systems.

How To Setup Player Verification

1. Go to Webhooks.

2. Enter the full URL of your endpoint in the login webhooks config box, for example, http://example.com/tebex/verification.php. You can use any programming language to create your endpoint as long as it returns the response as listed below.

Accepting Notifications And Returning A Response

Example Request

When a customer attempts to log in to your webstore we will send a GET request to the URL you have previously set as outlined above. An example request URL would look like the following: ​

http://example.com/tebex/verification.php?ign=Notch&ip=127.0.0.1&country=US

Request Query Parameters

1. ign - The username of the customer attempting to log in.

2. ip - The IP address of the customer attempting to log in.

3. country - The country code of the customer (Based on GEO locating their IP address).

Example Response

To allow the customer to log in based on the provided query parameters you need to return a JSON response such as the following example: ​

{  
    "verified":true,
    "message":"An optional message to send to the customer upon login. This field is optional."
}
​

​ If you don't want to allow the customer to login you can return a JSON response such as: ​

{
    "verified":false,
    "error":"You are not allowed to access our webstore."
}
​

Upon creating your store you may notice the footer at the bottom of your store stating that it is powered by Tebex and that we are the reseller & merchant of record.

Hiding the footer on your webstore will void our terms and conditions and will result in us having to disable your store from the public.

As a merchant of record platform we are under strict requirements by the card networks, such as Visa & Mastercard, to ensure customers understand which company they are purchasing from. You are authorising Tebex to operate a webstore on your behalf and sell content that we license from you, thus we need to let customers know about this as clearly as possible.

We don't place the footer for our own marketing/branding benefit - we simply have to do it to be able to provide you with all the benefits you receive as us being the Merchant Of Record, such as:

1. 100 payment method integrations

2. Sales tax collection and remittance worldwide

3. Fraud protection & our chargeback guarantee

4. Easy to integrate product delivery for your game studio & server

Styling the footer to match your own brand

The colour scheme of the footer by default matches your Tebex Checkout theme. You're able to select between Dark or Light mode by viewing your Checkout settings within the creator panel.

The footer also listens to the following CSS variables which you can define in your template/theme, providing you with further customisation ability:

An example of setting the CSS variables can be seen below, which you could place in your templates CSS file:

:root {
  --tebex-legal-footer-background-color: #fcba03;
  --tebex-legal-footer-text-color: #4c00ff;
}

Events are fired by Tebex.js upon specific actions to alert your frontend and enable you to take action when required. These events should not be used to confirm actual receipt of payment - you should use Webhooks instead.

To add an event callback, use Tebex.checkout.on() . The first argument to this function should be the name of the event to listen to, and the second argument should be a function to call when that function is fired:

Tebex.checkout.on("payment:complete", (event) => {
    console.log("Payment completed!", event);
});

Available events are as follows:

All events that can be listened to with Tebex.checkout.on() are exposed on the element as custom DOM events, which means you can use addEventListener to subscribe to them:

<html>
    <body>
        <tebex-checkout id="checkout"></tebex-checkout>
    </body>
    <script>
        const checkout = document.getElementById("checkout);
        
        checkout.addEventListener("open", () => {
            console.log("checkout opened");
        });

        checkout.addEventListener("close", () => {
            console.log("checkout closed");
        });

        checkout.addEventListener("payment:complete", (event) => {
            console.log("payment completed", event);
        });

        checkout.addEventListener("payment:error", (event) => {
            console.log("payment errored", event);
        });
    </script>
</html>

You will receive a webhook notification when the customer has created their webstore and their game server is ready to have the Tebex plugin automatically installed. Upon receipt of the webhook you should do the following:

1. Download the Tebex plugin and install it onto the game server using the provided url.

2. Download the premade config file and install it onto the game server (or manually create the config file depending on the game type, using the secret parameter in the webhook).

3. Restart the game server to allow the Tebex Plugin to notify us that the plugin has been installed and authenticated against the webstore.

Setup Your Webhook URL

You can specify the url of your webhook handler (such as serverhost.com/tebex.php) within the settings section of your affiliate control panel.

Authentication

To verify that the webhook has been sent from Tebex, we send a X-Tebex-Signature header that contains a HMAC using SHA256 created by the POST body (JSON) using your Webhook Signature Secret as the key.

You can find your Webhook Signature Secret within the setting section of your affiliate panel and example of calculating the signature in PHP is below:

$body = file_get_contents("php://stdin");
$secret = "myagreedsecret";
$signature = hash_hmac("sha256", $body, $secret);

if ($signature != $_SERVER['HTTP_X_TEBEX_SIGNATURE']) {
    return "Invalid signature";
}

Example Webhook Notification

{
    "reference": "123456",
    "secret": "9a6747fc6259aa374ab4e1bb03074b6ec672cf99",
    "game_type": {
        "id": 1,
        "plugins": {
            "bukkit": {
                "platform": "bukkit",
                "version": "10.2",
                "url": "https://d2vpaemuugs53a.cloudfront.net/latest/10.2/bukkit/BuycraftX.jar",
                "config": "http://affiliate.tebex.io/api/referrals/123456/config/bukkit"
            },
            "sponge": {
                "platform": "sponge",
                "version": "10.2",
                "url": "https://d2vpaemuugs53a.cloudfront.net/latest/10.2/sponge/BuycraftX.jar",
                "config": "http://affiliate.tebex.io/api/referrals/123456/config/sponge"
            },
            "bungeecord": {
                "platform": "bungeecord",
                "version": "10.2",
                "url": "https://d2vpaemuugs53a.cloudfront.net/latest/10.2/bungeecord/BuycraftX.jar",
                "config": "http://affiliate.tebex.io/api/referrals/123456/config/bungeecord"
            },
            "forge": {
                "platform": "forge",
                "version": "12.0.1",
                "url": "https://d2vpaemuugs53a.cloudfront.net/latest/minecraft-java/12.0.1/forge/BuycraftX.jar",
                "config": "http://affiliate.tebex.io/api/referrals/123456/config/forge"
            }
        }
    },
    "setup_at": "2020-11-17T09:41:57+00:00"
}

The Game Server API is for implementing command execution on game servers - an example of this would be the official Tebex Minecraft Plugin.

If you haven't already done so, we recommend having a read of our quick start guide before beginning integration.

Official Game Server Plugins

You can download compiled versions of the official plugins that implement this API from the Game Servers section of the creator panel.

The source code for these plugins can also be found in the following GitHub repositories:

• BuycraftX (Minecraft: Java Edition)

• Tebex-Oxide (Rust, 7 Days To Die and Hurtworld)

• Tebex-Ark (ARK: Survival Evolved)

• Tebex-FiveM (FiveM / GTA V)

• Tebex-Forge

• Tebex-uMod

• Tebex-Atlas

• Tebex-TorchAPI

• Tebex-Gmod

• Tebex-Unturned

RCON Adapter

If we don't have a plugin available for your game you're also able to make use of the RCON Adapter.

The Webstore Builder enables you to fully customise the design of your store using templates & themes, providing your customers with a seamless transition from your existing website when they're making a purchase.

If you haven't already done so, we recommend having a read of our quick start guide before continuing.

With the webstore builder, you can:

1. Use templates to change the HTML structure of each page and implement conditional logic via the TWIG templating engine.

2. Upload custom CSS, Javascript and images via Assets.

3. If you're a template designer, you can offer your customers the ability to customise their templates via Config Schema, and you're also eligible for free Plus via our Developer Plan.

Examples

Browse examples of other Tebex stores for some inspiration.

Certified Tebex Designers

If you're a designer who creates templates for others, either for free or to sell, let us know! We'll add you to the certified Tebex designers club. You'll gain access to insider help guides, a private community of other designers, feedback sessions with the Tebex product team, and also BETA features that are not yet available to others.

Feedback

If there are any functions, tags, filters or variables that you need to use in your template, but they're not available or documented, please let us know.

Getting Started

To create your first template, head over to the Appearance section within your creator panel.

As a creator using Checkout API, you must authenticate directly with the API as opposed to individual customers authenticating.

Authorization

We use HTTP BASIC for authorization, and all requests are made over HTTPS so that your credentials are protected.

Content Type

All requests use application/json as the Content-Type. Ensure this is set with all requests to our Checkout API.

Example

const url = "https://checkout.tebex.io/api/checkout";

const headers = new Headers();
headers.append('Authorization', 'Basic ' + btoa(username + ':' + password));
headers.append('Content-Type', 'application/json');

const options = {
        method: 'POST', // Use 'GET', 'POST', 'PUT', etc. as needed
        headers: headers
};

const response = await fetch(url, options);
// etc

This guide will detail the expected flows and endpoints for implementing tiers using Headless API.

See our Creator docs for Tiered Packages to learn how to set up tiers.

Checkout Flow

Tiers require an authenticated user. After you create the basket, you must log the user in using the relevant basket auth links.

See Creating A Basket for further information.

The expected flow for checking out with a Tier is identical to any other package:

1. Create the basket

2. Authenticate the user via the basket's auth links

3. Add the tiered package to the basket

4. Direct the user to checkout

On successful checkout, the user will now have an active_tier when retrieving their tiered categories against their usernameId.

If the active_tier property is not present, the user does not have an active package in that tier.

API Endpoints

Tiered categories use our existing /categories endpoint.

Unlike other Headless API endpoints, you must use HTTP Basic authentication with the Username set to your project ID and Password as your secret key.

Provide a usernameId as a query parameter to check for an active_tier

All tiered categories will have the property tiered: true

The payments module allows you to display a selection of recent payments received from customers on your store.

Payment Object

Request Variable

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

The category.html page lists the packages 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, 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.

Filters enable you to modify the content of variables within your template.

If you'd like access to a TWIG filter that is not available below,

Available Filters

Filter Documentation

money

The money filter transforms a variable into a monetary format.

Functions generate content for you to use within your templates.

If you'd like access to a TWIG function that is not available below,

Available Functions

Function Documentation

__

Returns the equivalent translation from within your translations settings.

_p

Returns the plural translation from within your translation settings.

config

Returns a config value from your .

asset

Returns the full url path of an asset from within your template.

path

Returns the full url path of the current page.

query

Returns a GET parameter from the current url.

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

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

The Headless API works with your existing packages, coupons, sales & creator codes.

If you haven't already done so, we recommend having a read of our before beginning integration.

You can query the Headless API to retrieve your packages/categories, build a basket for a user, and direct them to checkout - all from within your own frontend implementation (be that a website or in-game).

The Headless API can be used with for a fully embedded checkout experience without the user ever leaving your own website.

Headless API Flow

Below is the expected flow your application should follow when utilizing the Headless API. For a list of all endpoints, please see the page.

Packages & Listings

You can retrieve your store's listings in JSON format and display them however you wish:

Creating Baskets

In order to purchase items, a basket must be created for the customer. Create a basket and allow the customer to login with their username or other OAuth login mechanism (e.g Steam or FiveM).

Adding and Removing Packages

You can add or remove packages programmatically to the created basket via the API as needed when the user interacts with your application.

Coupons, Gift Cards, and Creator Codes

Once all packages and quantities are selected, apply any relevant coupons, gift cards, or creator codes with these endpoints.

Checkout

When the user is ready to checkout, fetch the basket and direct the user to the links.checkout URL.

Starter Template

To get started with your own integration of the Headless API you're able to use our example integration built upon Nuxt.js, Vue & Typescript. Take a look at the GitHub repo to begin.

Examples

The following websites are built using the Headless API - hosted via our customers own infrastructure, using frontend frameworks such as Vue or React.

Depending on the type of Tebex store you are integrating, additional parameters may be necessary before the basket can be successfully created.

Authorizing Baskets

For most stores, the user must authorize their account before checkout is completed. This is done via the /auth endpoint where we will return the authentication options available for your store.

Provide a returnUrl , and after successful authentication the user will be directed back to your site.

Minecraft and Overwolf Stores

You must provide the username parameter as part of the basket creation request so that the basket is attributed to the correct user:

The Basket which is returned will include the username_id which may be required for certain endpoints.

You should save the username_id as part of the user's session for use later.

Universal Stores

No username is required, but depending on your package Deliverables you may need to provide variable_data so that the package is attributed to the correct user. See .

If you are creating a basket on your backend server, you will need to provide us the IP address of the customer through the If you are creating a basket from the user's browser, we will automatically determine the IP from the requesting device.

Authorization

If you’re being asked for authentication; you'll need to use HTTP BASIC with the following details:

Content Type

All requests use application/json as the Content-Type. Ensure this is set with all requests to our Headless API.

Example of an authenticated request

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.

Get Game Types

GET https://affiliate.tebex.io/api/game-types

Retrieve a list of all games that the Tebex Platform supports.

Headers

{
  "data": [
    {
      "id": 1,
      "name": "Minecraft: Java Edition"
    },
    {
      "id": 2,
      "name": "Minecraft (Bedrock)"
    },
    {
      "id": 3,
      "name": "Minecraft Offline"
    },
    {
      "id": 4,
      "name": "Unturned"
    },
    {
      "id": 5,
      "name": "Rust"
    },
    {
      "id": 6,
      "name": "7 Days to Die"
    },
    {
      "id": 7,
      "name": "Garry's Mod"
    },
    {
      "id": 8,
      "name": "Counter-Strike: Global Offensive"
    },
    {
      "id": 9,
      "name": "Team Fortress 2"
    },
    {
      "id": 10,
      "name": "Hurtworld"
    },
    {
      "id": 11,
      "name": "ARK: Survival Evolved"
    },
    {
      "id": 12,
      "name": "Space Engineers"
    },
    {
      "id": 13,
      "name": "ATLAS"
    },
    {
      "id": 14,
      "name": "GTA V"
    },
    {
      "id": 15,
      "name": "FiveM"
    }
  ]
}