API Integration Guide for Minecraft directory websites

You can build your directory website in basically anything. This guide is not a comprehensive coding tutorial. I'm just offering some basic insight into how you could integrate with this plugin.

API Request Payload

This is a sample payload that the plugin sends to your configured API endpoint:


{
  "buildName": "Castle",
  "player_username": "PlayerName",
  "player_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "server": {
    "ip": "192.168.1.100",
    "port": "25565",
    "name": "MyMinecraftServer",
    "version": "1.20.4"
  },
  "region": {
    "name": "castle_region",
    "corners": [[100, 64, 100], [150, 80, 150]]
  },
  "tp_location": {
    "x": 125,
    "y": 65,
    "z": 125
  },
  "blocks": {
    "STONE": 150,
    "OAK_PLANKS": 80,
    "GLASS": 20
  }
}

Your custom rest api endpoint needs to be able to handle POST requests with the Content-Type being application/json. The request body will follow the sample schema above.