README

Access Sponge powered Minecraft servers through a WebAPI

Introduction

This is the documentation of the various API routes offered by the WebAPI plugin.
This documentation assumes that you are familiar with the basic concepts of Web API's, such as GET, PUT, POST and DELETE methods, request HEADERS and RESPONSE CODES and JSON data.
By default this documentation can be found at http:/localhost:8080 (while your minecraft server is running) and the various routes start with http:/localhost:8080/api/v5...
As a quick test try reaching the route http:/localhost:8080/api/v5/info (remember that you can only access \"localhost\" routes on the server on which you are running minecraft). This route should show you basic information about your server, like the motd and player count.

List endpoints

Lots of objects offer an endpoint to list all objects (e.g. GET: /world to get all worlds). These endpoints return only the properties marked 'required' by default, because the list might be quite large. If you want to return ALL data for a list endpoint add the query parameter details, (e.g. GET: /world?details).

Remember that in this case the data returned by the endpoint might be quite large.

Debugging endpoints

Apart from the ?details flag you can also pass some other flags for debugging purposes. Remember that you must include the first query parameter with ?, and further ones with &:

• details: Includes details for list endpoints
• accept=[json/xml]: Manually set the accept content type. This is good for browser testing, BUT DON'T USE THIS IN PRODUCTION, YOU CAN SUPPLY THE Accepts HEADER FOR THAT
• pretty: Pretty prints the data, also good for debugging in the browser.

An example request might look like this: http://localhost:8080/api/v5/world?details&accpet=json&pretty&key=MY-API-KEY

Additional data

Certain endpoints (such as /player, /entity and /tile-entity have additional properties which are not documented here, because the data depends on the concrete object type (eg. Sheep have a wool color, others do not) and on the other plugins/mods that are running on your server which might add additional data.
You can also find more information in the github docs (https:/github.com/Valandur/Web-API/tree/master/docs/DATA.md)

Swagger

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 5.4.2-S7.1.0
• Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit https://github.com/Valandur

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-WebAPI-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-WebAPI-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');

$apiInstance = new Swagger\Client\Api\ActiveTimeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$details = true; // bool | Add to include additional details, omit or false otherwise
$accept = "accept_example"; // string | Override the 'Accept' request header (useful for debugging your requests)
$pretty = true; // bool | Add to make the Web-API pretty print the response (useful for debugging your requests)

try {
    $result = $apiInstance->getServerReport($details, $accept, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActiveTimeApi->getServerReport: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://localhost/api/v5

Documentation For Models

• AcceptsItems
• Account
• Advancement
• AgeableData
• ArmorSlotType
• ArmorStandData
• AuthenticationRequest
• BannerData
• BeaconData
• BlockOperation
• BlockState
• BreathingData
• BrewingStandData
• CachedObject
• Career
• CatalogType
• CatalogTypeAdvancementTree
• CatalogTypeCurrency
• CatalogTypeDifficulty
• CatalogTypeDimensionType
• CatalogTypeEntityType
• CatalogTypeGameMode
• CatalogTypeGeneratorType
• CatalogTypeInventoryArchetype
• CatalogTypeWeather
• Cause
• Chunk
• Color
• Command
• CommandCall
• CommandData
• CommandResult
• CommandTask
• CreateBlockOperationRequest
• CreateEntityRequest
• CreateUserRequest
• CreateWorldRequest
• Currency
• DamageRequest
• DamageableData
• DespawnDelayData
• DurabilityData
• DyeColor
• Enchantment
• EndGatewayData
• Entity
• EntityArchtype
• EntitySnapshot
• EquipmentSlotType
• ExecuteCommandRequest
• ExecuteCommandResponse
• ExecuteMethodParam
• ExecuteMethodRequest
• ExecuteMethodResponse
• ExperienceHolderData
• FallingBlockData
• FireworkEffect
• FireworkRocketData
• FluidStack
• FoodData
• FurnaceData
• FuseData
• GameMode
• GrowthData
• GuiIdProperty
• HealthData
• HideData
• HorseData
• Identifiable
• IgniteableData
• InlineResponse400
• InlineResponse401
• InlineResponse403
• InlineResponse404
• InlineResponse500
• InteractiveMessage
• InteractiveMessageOption
• Inventory
• InventoryCapacity
• InventoryDimension
• InventoryTitle
• InvisibilityData
• InvulnerabilityData
• ItemStack
• JoinData
• LeashData
• LocalDate
• Location
• MegaMenusElement
• MegaMenusRenderer
• MenuMenusMenu
• Message
• MinecartBlockData
• MobSpawnerData
• ModifyBlockOperationRequest
• ModifyUserRequest
• PatternLayer
• PermissionStruct
• PickupDelayData
• Player
• PluginContainer
• PluginDependency
• PotionEffect
• RedProtectRegion
• Schedule
• ServerInfo
• ServerProperty
• ServerReport
• ServerStat
• ServerStatDouble
• ServerStatInteger
• ServerStats
• SlimeData
• Slot
• SlotIndex
• SlotPos
• SlotRequest
• SlotSide
• Stat
• StructureData
• Subject
• SubjectCollection
• TableEntry
• TableEntryEntityArchetype
• TameableData
• TileEntity
• TimeHolder
• TradeOffer
• Transform
• UniversalMarketItem
• UpdateEntityRequest
• UpdatePlayerRequest
• UpdateTileEntityRequest
• UpdateWorldRequest
• UserPermissionStruct
• UserReport
• Vector2i
• Vector3d
• Vector3i
• VehicleData
• VillagerShopsShop
• VillagerShopsStockItem
• WebBooksBook
• WireAttachmentData
• World
• WorldBorder
• BlockChangeOperation
• BlockGetOperation
• ChatMessage

Documentation For Authorization

ApiKeyHeader

• Type: API key
• API key parameter name: X-WebAPI-Key
• Location: HTTP header

ApiKeyQuery

• Type: API key
• API key parameter name: key
• Location: URL query string

Author

inithilian@gmail.com