Download the PHP package multiplayer-gratis/api-client without Composer

On this page you can find all versions of the php package multiplayer-gratis/api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of multiplayer-gratis/api-client

Informations about the package api-client

multiplayer.gratis PHP API Client

PHP-Client für die REST-API von multiplayer.gratis – kostenloses Gameserver-Hosting.

Installation

Voraussetzungen: PHP 8.1+, ext-curl, ext-json.

Authentifizierung

Erstelle einen API-Schlüssel im Dashboard unter API. Behandle ihn wie ein Passwort – am besten aus einer Umgebungsvariable laden statt ihn im Code zu hinterlegen.

Verwendung

Alle Methoden geben die JSON-Antwort der API als assoziatives Array zurück.

Methode Endpunkt
getAccount() GET /account
getServers() GET /servers
getServer($id) GET /servers/{id}
getServerResources($id) GET /servers/{id}/resources
sendPowerSignal($id, $signal) POST /servers/{id}/power

Fehlerbehandlung

Fehler der API ({ "error": "…" }) werden als Exceptions geworfen. Alle erben von MultiplayerGratis\Exception\ApiException.

Status Exception Bedeutung
401 AuthenticationException Schlüssel fehlt oder ist ungültig
404 NotFoundException Server nicht gefunden
409 ConflictException Server abgelaufen oder nicht steuerbar
423 LockedException Vom Team gesperrt
429 RateLimitException Mehr als 60 Anfragen pro Minute
– TransportException API nicht erreichbar (Netzwerkfehler)

Eigener HTTP-Transport

Standardmäßig wird cURL genutzt. Timeouts lassen sich anpassen oder ein eigener Transport über HttpClientInterface übergeben (z. B. für Tests):

Tests

Lizenz

MIT – siehe LICENSE.

All versions of api-client with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
ext-curl Version *
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package multiplayer-gratis/api-client contains the following files

Loading the files please wait ...