POST https://affiliate.tebex.io/api/referrals
This endpoint should be called when your customer requests that they want to install Tebex on their game server. It will send an email to the customer containing a link which allows them to setup their webstore and ensure your affiliate account is associated with the customer.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
GET https://affiliate.tebex.io/api/referrals/:reference
Retrieve an existing referral. This method is useful for checking if a customer has created their webstore and can also be used to retrieve the plugin urls and locations of the premade config files.
GET https://affiliate.tebex.io/api/referrals/:reference/config/:platform
Retrieve the premade config file for a specific platform (such as Minecraft Spigot or Forge). The config file will include the customer's secret key, removing any need of manual setup of the Tebex plugin on the server's behalf.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
Authorization
string
Bearer <Your API Key>
link
string
The UUID of your referral link within your affiliate panel. You can find this on https://affiliate.tebex.io/links, under your Link name.
reference
string
A unique ID that references the customer's game server within your management panel. You will use this to identify the game server when we send the installation webhook.
game_type_id
number
The ID of the game type found within the game types endpoint.
server_name
string
The name of your customer's game server.
string
The email address of the customer.
last_name
string
The last name of the customer.
first_name
string
The first name of the customer.
reference
string
The reference provided when you created the referral.
Authorization
string
Bearer <Your API Key>
platform
string
The plugin platform such as bukkit or forge.
reference
string
The reference provided when you created the referral.
Authorization
string
Bearer <Your API Key>