Tebex

https://docs.tebex.io/developers
Admin
Tebex is a monetization platform that provides multiple integration methods including Webstore...
Tokens:114,388
Snippets:799
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Get webstore information - response

Source: https://docs.tebex.io/developers/headless-api/endpoints

Example 200 response for the get webstore information endpoint, returning the webstore's information wrapped in a 'data' object.

```json
{
  "data": {
    "id": 1,
    "description": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris fermentum eget tellus et cursus. Pellentesque vel vehicula velit, sit amet tincidunt diam. Aliquam sit amet fermentum lorem.</p>",
    "name": "Minecraft Store",
    "webstore_url": "https://example.tebex.io",
    "currency": "USD",
    "lang": "en",
    "logo": "https://example.com",
    "platform_type": "Minecraft: Java Edition",
    "platform_type_id": "minecraft",
    "disabled": false,
    "created_at": "2023-05-25T09:49:37+00:00",
    "supports_usernames": true,
    "supports_gifting": false
  }
}
```

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

### Headless API: Get all categories and packages

Source: https://docs.tebex.io/developers/unity-engine/faq

Use HeadlessApi.GetInstance with your public token to fetch store data and build a custom UI. The example shows async callbacks for success, API errors, and server errors.

```csharp
var api = HeadlessApi.GetInstance(new UnityHeadlessAdapter(), "your-public-token");

await api.GetAllCategoriesIncludingPackagesAsync(
    onSuccess: categories => { /* populate your own UI */ },
    onApiError: err => Debug.LogError(err.detail),
    onServerError: err => Debug.LogError(err.Body)
);
```

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

### GET /api/game-types - Example Response

Source: https://docs.tebex.io/developers/affiliate-api/game-types

Example JSON response from the GET /api/game-types endpoint, showing a list of supported games with their IDs and names.

```json
{
  "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"
    }
  ]
}
```

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

### Get Referral Config File - 200 Response

Source: https://docs.tebex.io/developers/affiliate-api/referrals

Example response from the Get Referral Config File endpoint (GET /api/referrals/:reference/config/:platform) when successfully retrieving the premade config file. Contains the customer's secret key and plugin settings.

```properties
#BuycraftX configuration file
push-commands=true
server-key=a8ba0940f9deb37b79d66fa19f8b36ba5df14fa2
verbose=false
disable-buy-command=false
check-for-updates=true
buy-command-name=buy
is-bungeecord=false
language=en-GB
```

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

### Common Twig File Example

Source: https://docs.tebex.io/developers/templates/twig

A typical Twig template showing HTML with Twig control structures and variable output. Use this as a starting point for customizing Tebex store templates.

```twig
<!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>
```

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

### Authentication Example

Source: https://docs.tebex.io/developers/checkout-api/headers-and-authentication

Example of setting the Authorization and Content-Type headers for a Checkout API request.

```APIDOC
## Authentication Example

### Description
This example demonstrates how to set the required headers for a Checkout API request, including HTTP Basic authentication and the Content-Type header.

### Headers
- **Authorization** (string) - Required - HTTP Basic authentication header. Format: `Basic <base64(username:password)>` where username is the Project ID and password is the Private Key.
- **Content-Type** (string) - Required - Must be set to `application/json`.

### Request Example
javascript
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

```

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

### GET /api/referrals/:reference/config/:platform

Source: https://docs.tebex.io/developers/affiliate-api/referrals

Retrieves the premade config file for a specific platform (such as Minecraft Spigot or Forge). The config file includes the customer's secret key, removing the need for manual setup.

```APIDOC
## GET /api/referrals/:reference/config/:platform

### Description
Retrieves the premade config file for a specific platform (such as Minecraft Spigot or Forge). The config file includes the customer's secret key, removing the need for manual setup.

### Method
GET

### Endpoint
https://affiliate.tebex.io/api/referrals/:reference/config/:platform

### Path Parameters
- **platform** (string) - Required - The plugin platform such as bukkit or forge.
- **reference** (string) - Required - The reference provided when you created the referral.

### Headers
- **Authorization** (string) - Required - Bearer <Your API Key>

### Response
#### Success Response (200)
- The premade config file for the Tebex plugin.

#### Response Example
```
#BuycraftX configuration file
push-commands=true
server-key=a8ba0940f9deb37b79d66fa19f8b36ba5df14fa2
verbose=false
disable-buy-command=false
check-for-updates=true
buy-command-name=buy
is-bungeecord=false
language=en-GB
```
```

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

### Theme and color attributes example

Source: https://docs.tebex.io/developers/tebex.js/checkout/web-component

Example of setting the 'theme' and 'color-primary' attributes on the tebex-checkout element.

```html
<tebex-checkout theme="dark" color-primary="#ff0000"></tebex-checkout>
```

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

### GET /categories?includePackages=1 - Get all categories and packages

Source: https://docs.tebex.io/developers/headless-api/endpoints

Gets all categories from a webstore including packages. Returns a list of categories with package information.

```HTTP
GET /api/accounts/YOUR_PUBLIC_TOKEN/categories?includePackages=1 HTTP/1.1
Host: headless.tebex.io
Accept: */*

```

```JSON
{
  "data": []
}
```

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

### Install Tebex.js from NPM

Source: https://docs.tebex.io/developers/tebex.js/installation

Install the Tebex.js package from NPM using your preferred JavaScript package manager.

```bash
npm install @tebexio/tebex.js
```

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

### GET /api/accounts/YOUR_PUBLIC_TOKEN/packages?ipAddress={ipAddress}

Source: https://docs.tebex.io/developers/headless-api/guides/packages/get-package

Gets all packages from a webstore. Requires basic authentication.

```APIDOC
## GET /api/accounts/YOUR_PUBLIC_TOKEN/packages?ipAddress={ipAddress}

### Description
Gets all packages from a webstore.

### Method
GET

### Endpoint
`https://headless.tebex.io/api/accounts/YOUR_PUBLIC_TOKEN/packages?ipAddress={ipAddress}`

### Authorizations
- **basicAuth** - Authorization (string) - Required

### Parameters
#### Path Parameters
- **ipAddress** (string) - Required - An IP address can be provided with authenticated requests. Example: `127.0.0.1`

### Request Example
```
GET /api/accounts/YOUR_PUBLIC_TOKEN/packages?ipAddress={ipAddress} HTTP/1.1
Host: headless.tebex.io
Authorization: Basic username:password
Accept: */*
```

### Response
#### Success Response (200)
Successful response returns a list of package information.

#### Response Example
```
{
  "data": []
}
```

#### Error Response (422)
The provided request is invalid.
```

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

### Tebex.portal.init()

Source: https://docs.tebex.io/developers/tebex.js/payment-portal

Initializes the payment portal with the required configuration options. Must be called before launching the portal.

```APIDOC
## Tebex.portal.init()

### Description
Initializes the payment portal with the required configuration options. Must be called before launching the portal.

### Method
init

### Parameters
#### Options Object
- **token** (string) - Required - The Public Token found on the API Keys page in your project's settings.
- **theme** (string) - Optional - UI color theme. Must be one of: `"light"`, `"dark"`, `"auto"`. Default: `"auto"`.
- **colors** (array) - Optional - UI brand colors. Default: `[]`. Each item is an object with `name` and `color` keys. `name` must be `"primary"` or `"secondary"`, `color` must be a valid CSS color.

### Request Example
```javascript
Tebex.portal.init({
    token: "project public token"
});
```

### Brand Color Example
```javascript
Tebex.portal.init({
    //..
    colors: [
        {
            name: "primary",
            color: "#910f0f",
        },
        {
            name: "secondary",
            color: "#25c235"
        }
    ]
});
```

### Notes
- In some cases, pages with heavy ad content can trigger browser pop-up blocking when loading Tebex.js. This behaviour can be avoided by ensuring the page has minimal ads, or by redirecting users to the portal flow in a new tab.
```

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

### Start a new basket session with InGameCart

Source: https://docs.tebex.io/developers/unity-engine/examples/start-a-new-basket-session-ingamecart

Use this MonoBehaviour to start a new basket session when the player opens the store. Call StartSession with the player's in-game username, or use NewBasketWithEmail() for email. Add packages to the cart and open it when the player clicks 'Add to Cart'.

```csharp
using Tebex.TebexUnity;
using Tebex.Headless;
using UnityEngine;

public class StoreController : MonoBehaviour
{
    [SerializeField] InGameCart cart;

    // Call this once when the player opens the store.
    // Pass the in-game username; alternatively use NewBasketWithEmail().
    public void StartSession(string playerUsername)
    {
        cart.NewBasketWithUsername(playerUsername);
    }

    // Call this when the player clicks "Add to Cart" on a product.
    public void OnAddToCart(Package package)
    {
        cart.AddPackage(package);
        cart.Open(); // Slide the cart into view
    }
}
```

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

### query - Get GET parameter

Source: https://docs.tebex.io/developers/templates/twig/functions

Returns a GET parameter from the current URL. The example returns the GET param of 'test' if it is provided in the URL.

```twig
{{ query("test" }}

// Returns the GET param of "test" if it is provided in the URL.
```

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

### Install Tebex C# SDK

Source: https://docs.tebex.io/developers/headless-api

Install the official Tebex SDK for C# using the .NET CLI, version 1.1.0. Recommended for streamlined API calls and automatic updates.

```bash
dotnet add package Tebex.CSharp --version 1.1.0
```

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

### Get Referral - 200 Response

Source: https://docs.tebex.io/developers/affiliate-api/referrals

Example response from the Get Referral endpoint (GET /api/referrals/:reference) when successfully retrieving an existing referral. Includes the secret, game type plugins with URLs and config endpoints, and setup_at.

```json
{
  "data": {
    "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"
  }
}
```

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

### Full Working Example Supporting Both Login Types

Source: https://docs.tebex.io/developers/templates/pages/username.html

A complete template that handles both external and non-external login providers using an if/else condition on the external variable.

```html
{% 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 %}
```

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

### Get packages by IP address - HTTP request

Source: https://docs.tebex.io/developers/headless-api/guides/packages/get-package

Gets all packages from a webstore. Requires basicAuth authorization and an ipAddress query parameter. The example includes the Authorization header.

```http
GET /api/accounts/YOUR_PUBLIC_TOKEN/packages?ipAddress={ipAddress} HTTP/1.1
Host: headless.tebex.io
Authorization: Basic username:password
Accept: */*

```

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

### Tebex.checkout.init()

Source: https://docs.tebex.io/developers/tebex.js/checkout

Initializes the Tebex checkout with the required configuration options. Must be called before launching the checkout.

```APIDOC
## Tebex.checkout.init()

### Description
Initializes the Tebex checkout with the provided configuration options. This method must be called before the checkout can be launched.

### Method
`Tebex.checkout.init(config)`

### Parameters
#### config (Object) - Required
- **ident** (string) - Required - The checkout request ident received via the Webstore Builder, Headless API, or Checkout API.
- **locale** (string) - Optional - Default language for checkout text, specified as an ISO locale code (e.g., `"en_US"`). Default: English.
- **theme** (string) - Optional - Checkout color theme. Must be one of: `"light"`, `"dark"`, `"auto"`, or `"default"`. Default: `"default"`.
- **colors** (Array) - Optional - Checkout brand colors as an array of objects with `name` and `color` keys. Default: `[]`.
- **defaultPaymentMethod** (string) - Optional - The default payment method ID to be selected when the user loads the checkout.
- **closeOnPaymentComplete** (boolean) - Optional - If enabled, the checkout popup will automatically close when payment completes. Default: `false`.

### Request Example
```javascript
Tebex.checkout.init({
    ident: "checkout request ident"
});
```

### Brand Color Config Example
```javascript
Tebex.checkout.init({
    //..
    colors: [
        {
            name: "primary",
            color: "#910f0f",
        },
        {
            name: "secondary",
            color: "#25c235"
        }
    ]
});
```

### Notes
- The `ident` can be retrieved using the `{{ basket.ident }}` global Twig variable if using a Tebex hosted webstore.
- Pages with heavy ad content may trigger browser pop-up blocking; consider minimizing ads or redirecting to a new tab.
```

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

### CustomStoreFlow MonoBehaviour using HeadlessAPI

Source: https://docs.tebex.io/developers/unity-engine/examples/using-headlessapi-directly-advanced

Use this C# script to initialize the HeadlessAPI with a public token, fetch all categories including packages, and create a basket for a player. It requires the Tebex.Headless and UnityEngine namespaces. The example shows async methods with callbacks for success and error handling.

```csharp
using Tebex.Headless;
using UnityEngine;

public class CustomStoreFlow : MonoBehaviour
{
    HeadlessApi api;

    async void Start()
    {
        api = HeadlessApi.GetInstance(new UnityHeadlessAdapter(), "your-public-token");

        // Fetch all categories with their packages
        await api.GetAllCategoriesIncludingPackagesAsync(
            onSuccess: categories =>
            {
                foreach (var cat in categories)
                    Debug.Log($"{cat.name}: {cat.packages.Count} packages");
            },
            onApiError: err => Debug.LogError($"API Error: {err.detail}"),
            onServerError: err => Debug.LogError($"Server Error {err.Code}: {err.Body}")
        );

        // Create a basket for a player
        var payload = new CreateBasketPayload
        {
            username = "PlayerOne",
            complete_url = "https://yoursite.com/thanks",
            cancel_url = "https://yoursite.com/store"
        };

        await api.CreateBasketAsync(
            payload: payload,
            onSuccess: basket =>
            {
                Debug.Log($"Basket created: {basket.ident}");
                Debug.Log($"Checkout: {basket.links.checkout}");
            },
            onApiError: err => Debug.LogError(err.detail),
            onServerError: err => Debug.LogError(err.Body)
        );
    }
}
```

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

### Successful response for Get Categories

Source: https://docs.tebex.io/developers/headless-api/guides/categories/get-categories

A successful response returns a list of category information. The example shows an empty data array.

```json
{
  "data": []
}
```

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

### asset - Get asset URL

Source: https://docs.tebex.io/developers/templates/twig/functions

Returns the full URL path of an asset from within your template. The example prints the URL of style.css, such as https://your-store.tebex.io/template-assets/style.css.

```twig
{{ asset("style.css") }}

// Prints the URL of style.css, such as https://your-store.tebex.io/template-assets/style.css"
```

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

### Install Tebex PHP SDK

Source: https://docs.tebex.io/developers/headless-api

Install the official Tebex SDK for PHP using Composer. Recommended for streamlined API calls and automatic updates.

```bash
composer require tebex/tebex-sdk-php
```

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

### config - Get config value

Source: https://docs.tebex.io/developers/templates/twig/functions

Returns a config value from your template config schema. The example prints the associated config value with the key 'header-colour'.

```twig
{{ config("header-colour") }}

// prints the associated config value with the key header-colour
```

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

### Install Tebex Node.js SDK

Source: https://docs.tebex.io/developers/headless-api

Install the official Tebex SDK for Node.js using npm. Recommended for streamlined API calls and automatic updates.

```bash
npm install tebexio/tebex-sdk-nodejs
```

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

### Example webhook notification JSON payload

Source: https://docs.tebex.io/developers/affiliate-api/webhooks

This JSON example shows the structure of a webhook notification sent by Tebex. It includes the reference, secret, game type details with plugin URLs and config URLs for various platforms (bukkit, sponge, bungeecord, forge), and the setup timestamp.

```json
{
    "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"
}
```

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

### Example response allowing login

Source: https://docs.tebex.io/developers/webhooks/login-webhooks

Return this JSON to allow the customer to log in. The 'message' field is optional and sent to the customer upon login.

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

```

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

### Tebex.portal.launch()

Source: https://docs.tebex.io/developers/tebex.js/payment-portal

Launches the payment portal for the user. On desktop devices it opens as a popup, on mobile devices as a new tab.

```APIDOC
## Tebex.portal.launch()

### Description
Launches the payment portal for the user. On desktop devices it opens as a popup, on mobile devices as a new tab.

### Method
launch

### Parameters
None

### Request Example
```javascript
Tebex.portal.launch();
```

### Usage Example
```html
<!-- Include the Tebex.js script here -->
<script>
  function launchPortal() {
    Tebex.portal.init({
      portal: "your project's public token goes here"
    });
    Tebex.portal.launch();
  }
</script>
<!-- ... -->
<button onclick="launchPortal()">View payment history</button>
```

### Notes
- If you are only calling `Tebex.portal.launch()` inside a click event, you might prefer to also call `Tebex.portal.init()` inside your click handler. This way, you don't need to wait for the page `load` event to fire to configure your portal.
```

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

### path - Get current page URL

Source: https://docs.tebex.io/developers/templates/twig/functions

Returns the full URL path of the current page. The example prints the full URL of the current page the customer is browsing on your store.

```twig
{{ path() }}

// Prints the full URL of the current page the customer is browsing on your store
```

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

### GET /api/accounts/YOUR_PUBLIC_TOKEN/sidebar - 200 Response

Source: https://docs.tebex.io/developers/headless-api/guides/sidebar/get-sidebar-modules

Example successful response containing an array of sidebar modules. Each module includes an id, type, start_time, end_time, and a data object with module-specific fields.

```json
{
  "data": [
    {
      "id": 1,
      "type": null,
      "start_time": "2026-01-01T00:00:00.000Z",
      "end_time": "2026-01-01T00:00:00.000Z",
      "data": {
        "header": "Top Customer",
        "username": "Test",
        "username_id": "d8d5a9237b2043d8883b1150148d6955",
        "total": 1
      }
    }
  ]
}
```

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

### Tebex.checkout.launch()

Source: https://docs.tebex.io/developers/tebex.js/checkout

Launches the Tebex checkout for the user. On desktop it opens as a popup, on mobile as a new tab.

```APIDOC
## Tebex.checkout.launch()

### Description
Launches the Tebex checkout to display the payment interface to the user. On desktop devices it opens as a popup, while on mobile devices it opens as a new tab.

### Method
`Tebex.checkout.launch()`

### Parameters
None.

### Usage Example
```javascript
<!-- Include the Tebex.js script here -->
<script>
  function checkout() {
    Tebex.checkout.init({
      ident: "your checkout request ident goes here"
    });
    Tebex.checkout.launch();
  }
</script>
<!-- ... -->
<button onclick="checkout()">Checkout</button>
```

### Notes
- If calling `launch()` inside a click event, it is recommended to also call `init()` inside the click handler to avoid waiting for the page `load` event.
```
Tokens:
Raw