canonical: https://jentic.com/apis/tebex.io/tebex-plugin-api

# Tebex Plugin API

The Tebex Plugin API enables game server plugins to interact with a Tebex webstore. It provides endpoints for managing command queues, payments, packages, checkout, gift cards, coupons, bans, sales, community goals, and player data. This API is used to implement command execution on game servers for. The API exposes 33 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get server information, get due players. Covers 33 operations with apiKey authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- Get server information
- Delete commands
- Integrate Tebex Plugin API into automated workflows
- Query and filter Tebex Plugin API records by parameters
- Monitor Tebex Plugin API operational status and events

## Use cases

### Payments Operations

Use the Tebex Plugin API to perform payments operations programmatically. The API provides 33 endpoints covering core functionality including get server information, get due players, delete commands.

Example prompt: Call GET /information to get server information

### Automated Information Management

Automate information operations by combining multiple Tebex Plugin API endpoints. Agents can get due players and then delete commands in a single workflow.

Example prompt: Call GET /queue to get due players, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Tebex Plugin API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'get server information', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/information` | Get server information |
| GET | `/queue` | Get due players |
| DELETE | `/queue` | Delete commands |
| GET | `/queue/offline-commands` | Get offline commands |
| GET | `/queue/online-commands/{playerId}` | Get online commands for a player |
| GET | `/listing` | Get listing (deprecated) |
| GET | `/packages` | Get all packages (deprecated) |
| GET | `/package/{packageId}` | Get a package (deprecated) |

## Key resources

- **Information** — General account and server information
- **Command Queue** — Manage command queues for due players
- **Packages** — Manage webstore packages
- **Payments** — Manage and retrieve payment information
- **Checkout** — Create checkout URLs for purchases

## Why Jentic

- **Setup:** Wiring the Tebex Plugin API by hand means setting up its secret key header, pointing calls at plugin.tebex.io, and writing the command-queue polling and retry glue yourself. Through Jentic you install once, import the Tebex Plugin API from the API Directory, store the secret key once, and your agent calls it.
- **Permission scoping:** The Tebex Plugin API puts the package id in the URL path (`/package/{packageId}`) and the player id in the queue path (`/queue/online-commands/{playerId}`), so a rule can pin your agent to one package or player. You choose the operations it may call, so state-changing ones like deleting from the queue are not included unless you add them.
- **Credential handling:** Your Tebex secret key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list packages' or 'read the command queue', and Jentic returns the matching Tebex Plugin API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Tebex Plugin API use?

The Tebex Plugin API uses an API key passed in the `X-Tebex-Secret` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get server information with the Tebex Plugin API?

Yes. Use the GET /information endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Tebex Plugin API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get server information through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get server information'. Jentic returns the matching Tebex Plugin API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Tebex Plugin API have?

The Tebex Plugin API exposes 33 endpoints covering information, command queue, packages operations.

### Can I limit what my agent is allowed to do with the Tebex Plugin API?

Yes. Because Jentic One is self-hosted, your own rules decide which Tebex Plugin API operations and credentials the agent may use, so you can grant read calls like GET /information and GET /queue while withholding state-changing ones such as DELETE /queue. Since the package id sits in the path (`/package/{packageId}`) and the player id sits in the queue path (`/queue/online-commands/{playerId}`), you can pin the agent to a single package or player. Your Tebex secret key is stored encrypted by your own instance and injected only when an allowed operation runs.