Introduction

Headless API is used to build custom frontends for your Tebex store, such as a website, app, or game.

The Headless API can retrieve your store's listings, create baskets, and send customers to checkout. It is the same API that backs Tebex-hosted webstores.

Like all Tebex APIs, it is a RESTful API that uses JSON-encoded requests and responses. It is documented with OpenAPI, which is used as the foundation for our SDKs and the documentation seen here.

API Specification: Tebex Headless OpenAPI Schema

Some endpoints may require prior approval or special account permissions. Please contact our support team if you encounter any issues.

Getting Started

Tebex provides SDKs to streamline your development environment and make API calls. These SDKs contain mappings for all our APIs, not just Headless API.

We recommend using these to avoid writing boilerplate code and to automatically receive updates when the API changes.

Node.js

npm install tebexio/tebex-sdk-nodejs

PHP

C#

If we do not have an official SDK in your language, the OpenAPI generator can be used to generate the code to interact with Tebex APIs without starting from scratch.

Using with Tebex.js

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

Examples

These projects use Headless API for part or all of their implementation and are open-source.

Tebex Unity Demo

An in-game store browser UI, basket, and QR-code based checkout in Unity Engine. Tebex for Unity Engine

Hytale Plugin

Hytale is a block-based survival game with a large private server community. Tebex provides an in-game store browser and cart with QR checkout, built on Headless API.

https://github.com/tebexio/Tebex-Hytale