Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Servers

Operations related to servers

Get servers

get

Retrieves information about all servers associated with your store. Use the page parameter to paginate results.

Authorization:

  • Requires a valid JWT Bearer token.

  • The token must include the permission: read-servers.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageintegerOptional

The page number to retrieve

Default: 1
max_pageintegerOptional

The maximum number of elements per page. This number must be between 5-50.

Default: 50
Responses
200

Successful operation

application/json
server_countnumberOptionalExample: 23
get/store/servers
GET /v1/store/servers HTTP/1.1
Host: api.tip4serv.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "servers": [
    {
      "id": 10200,
      "name": "My custom rust server",
      "game_name": "rust",
      "connected": true
    }
  ],
  "server_count": 23
}

Create a new Discord server

post

Creates and connects a new Discord server to your store using its discord_id.

Authorization:

  • Requires a valid JWT Bearer token.

  • The token must include the permission: create-servers.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
discord_idstringOptional

ID of the discord server.

Example: 1057619727985426400
Responses
200

Successful operation.

application/json
statusnumberOptionalExample: 200
messagestringOptionalExample: Your Discord server has been successfully created and connected.
server_idnumberOptional

The ID of your brand new Discord Server.

Example: 4040
post/store/discord_server
POST /v1/store/discord_server HTTP/1.1
Host: api.tip4serv.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "discord_id": 1057619727985426400
}
{
  "status": 200,
  "message": "Your Discord server has been successfully created and connected.",
  "server_id": 4040
}

Get the remaining actions to execute.

get

Get the remaining actions to execute.

Authorization:

  • Requires a valid JWT Bearer token.

  • The token must include the permission: read-delivery.

⚠ For Plugin Developers:

If you are implementing this endpoint inside a game plugin (Rust, Minecraft, FiveM, etc.), do not use a JWT Bearer token. Instead, authenticate using Server Keys, as described in our Plugin Development Guide.

→ Developing Plugins

Path parameters
idnumberRequired

The ID of the server.

Responses
200

Server commands found successfully

application/json
idstringOptional

Unique identifier of the payment/subscription. Can have the following prefix : pay_, sub_

Example: pay_71524
playerstringOptional

Player name of the customer.

Example: duster
usernamestringOptional

Username of the customer.

Example: Dusterito
minecraft_uuidstringOptional

Minecraft UUID of the customer.

Example: d4191228d7d247ab88cdb18636f4eecd
steam_idstringOptional

Steam ID of the customer.

Example: 76561198380145420
player_idstringOptional

Raw generic player identifier of the customer.

Example: C84A567
eos_idstringOptional

EOS ID of the customer.

Example: 0002e2f30b1f407cb21880d425a1e5eb
discord_idstringOptional

Discord ID of the customer.

Example: 274785054121525250
get/store/server/{id}/commands
GET /v1/store/server/{id}/commands HTTP/1.1
Host: api.tip4serv.com
Accept: */*

[
  {
    "id": "pay_71524",
    "player": "duster",
    "username": "Dusterito",
    "minecraft_uuid": "d4191228d7d247ab88cdb18636f4eecd",
    "steam_id": 76561198380145420,
    "player_id": "C84A567",
    "eos_id": "0002e2f30b1f407cb21880d425a1e5eb",
    "discord_id": 274785054121525250,
    "cmds": [
      {
        "id": 1,
        "state": "Execute",
        "str": "inventory.giveto 76561198380145423 scientist 5"
      }
    ]
  }
]

Update the actions and get the remaining server commands to execute.

post

Update the actions and get the remaining actions to execute.

Authorization:

  • Requires a valid JWT Bearer token.

  • The token must include the permission: update-delivery.

⚠ For Plugin Developers:

If you are implementing this endpoint inside a game plugin (Rust, Minecraft, FiveM, etc.), do not use a JWT Bearer token. Instead, authenticate using Server Keys, as described in our Plugin Development Guide.

→ Developing Plugins

Path parameters
idnumberRequired

The ID of the server.

Body

Map of payment IDs to their executed commands.

Responses
200

Server commands found successfully

application/json
idstringOptional

Unique identifier of the payment/subscription. Can have the following prefix : pay_, sub_

Example: pay_71524
playerstringOptional

Player name of the customer.

Example: duster
usernamestringOptional

Username of the customer.

Example: Dusterito
minecraft_uuidstringOptional

Minecraft UUID of the customer.

Example: d4191228d7d247ab88cdb18636f4eecd
steam_idstringOptional

Steam ID of the customer.

Example: 76561198380145420
player_idstringOptional

Raw generic player identifier of the customer.

Example: C84A567
eos_idstringOptional

EOS ID of the customer.

Example: 0002e2f30b1f407cb21880d425a1e5eb
discord_idstringOptional

Discord ID of the customer.

Example: 274785054121525250
post/store/server/{id}/commands
POST /v1/store/server/{id}/commands HTTP/1.1
Host: api.tip4serv.com
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "pay_71565": {
    "action": "payment",
    "cmds": {
      "0": "Executed",
      "1": "Executed"
    }
  },
  "pay_71566": {
    "action": "renewal",
    "cmds": {
      "0": "Executed",
      "1": "Not Executed"
    }
  }
}
[
  {
    "id": "pay_71524",
    "player": "duster",
    "username": "Dusterito",
    "minecraft_uuid": "d4191228d7d247ab88cdb18636f4eecd",
    "steam_id": 76561198380145420,
    "player_id": "C84A567",
    "eos_id": "0002e2f30b1f407cb21880d425a1e5eb",
    "discord_id": 274785054121525250,
    "cmds": [
      {
        "id": 1,
        "state": "Execute",
        "str": "inventory.giveto 76561198380145423 scientist 5"
      }
    ]
  }
]

Get server by ID

get

Retrieves information about a specific server identified by id.

Authorization:

  • Requires a valid JWT Bearer token.

  • The token must include the permission: read-servers.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idnumberRequired

The ID of the server to retrieve.

Responses
200

Server found successfully

application/json
idinteger · int64Required

Unique identifier of the server.

Example: 10200
namestringRequired

Name of the server.

Example: My custom discord server
game_namestringRequired

Game associated with the server.

Example: discord
connectedbooleanOptional

Indicates whether the server is currently connected.

Example: true
authstringRequired

Method used by the server to identify its players.

Accepted values: steamid, discordid, eosid, username, player_id

Example: discordid
discord_idinteger · int64Optional

Discord server ID if applicable.

Example: 1057619727985426400
get/store/server/{id}
GET /v1/store/server/{id} HTTP/1.1
Host: api.tip4serv.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 10200,
  "name": "My custom discord server",
  "game_name": "discord",
  "connected": true,
  "auth": "discordid",
  "discord_id": 1057619727985426400
}
PreviousStore
NextProducts

Last updated