Integration
Last updated
Was this helpful?
Last updated
Was this helpful?
Tebex.js enables you to integrate a seamless checkout experience for customers without them leaving your website or game.
Tebex.js is available as an NPM package, which you can install using your preferred JS package manager:
The Tebex
object can then be imported into your code like so:
Alternatively, we also provide Tebex.js via our own CDN, which you can add as a script within the <head>
tag of your website:
When installing Tebex.js this way, the Tebex
object will become available globally on the window
object.
We recommend using defer
on the script to prevent it from blocking your website's initial page render, but when doing do, it's important to wait for the page load
event before you begin configuring the checkout:
Before your checkout can be launched, it must first be configured by calling the Tebex.checkout.init()
method. This method takes an object containing config options:
ident
locale
Default language for checkout text. Specified as an ISO locale code, e.g. "en_US"
for American English, "de_DE"
for German, etc. Users can change the language from within the checkout panel UI.
English
theme
Checkout color theme. Must be one of the following options:
"light"
"dark"
"auto"
- applies the theme based on the user's light/dark mode system preference.
"default"
- applies the theme option you have selected in your store's settings.
"default"
colors
[]
Brand colors can be specified as an array of objects with name
and color
keys. name
must be either "primary"
or "secondary"
, while color
must be a valid CSS color:
When you are ready to show the Tebex.js checkout to your user, you can call the Tebex.checkout.launch()
method. On desktop devices this will open the checkout as a popup, while on mobile devices it will open as a new tab.
If you are only calling the Tebex.checkout.launch()
inside a click event, you might prefer to also call Tebex.checkout.init()
inside your click handler.
This way, you don't need to wait for the page load
event to fire to configure your checkout:
Required. This should be the checkout request ident received via the , or .
Checkout .