GermanMinerAPI Dokumentation

Version 2.0 - Aktualisiert am 31.01.2021

Erste Schritte

Um deinen API-Schlüssel zu verwalten, schreibe /gmapi in den Chat ein. Der API-Server akzeptiert sowohl GET als auch POST Anfragen. Bei jeder Anfrage muss der Parameter key mit deinem aktuellen API-Schlüssel enthalten sein.

Rückgaben

Die Antwort des API-Servers wird immer im JSON-Format zurückgegeben werden. JSON wird häufig zum Transfer von Daten zwischen Client und dem Server genutzt, und kann deswegen fast von jeder Programmiersprache einfach eingelesen werden. Wenn dies getan ist, sollte man prüfen, ob der Wert success auf true gesetzt ist, denn ansonsten ist bei der Anfrage etwas schiefgelaufen. Der Fehler kann jeweils durch den Wert error einfach ausgegeben werden.

PHP-Wrapper

Damit du dir nicht die Arbeit machen musst eine eigene Klasse für die API zu erstellen, haben wir bereits einen eigenen PHP-Wrapper erstellt! Beachte, dass der Code dafür automatisch generiert wurde, was bedeutet dass einige Naming Conventions möglicherweise nicht eingehalten wurden.

Verfügbare Funktionen

API

API-Informationen
https://api.germanminer.de/v2/api/info

Gibt Level und verbleibende Anfragen zurück.

BANK

Kontoauszug abrufen
https://api.germanminer.de/v2/bank/activitystatement
Kontoinformationen abrufen
https://api.germanminer.de/v2/bank/info
Auflistung aller Bankkonten
https://api.germanminer.de/v2/bank/list

Gibt alle Bankkonten zurück, auf die der Inhaber des API-Keys zugreifen kann

Transaktion tätigen
https://api.germanminer.de/v2/bank/transaction

COMPANY

FirmenShop-Statistiken einsehen
https://api.germanminer.de/v2/company/chestshop/stats
Firmenbeschreibung setzen
https://api.germanminer.de/v2/company/description/set

Eine Änderung über die API kostet wie im Bürgeramt auch 250 Euro.

Mitarbeiter kündigen
https://api.germanminer.de/v2/company/dismiss
Firmeninformationen abrufen
https://api.germanminer.de/v2/company/info
Lohn setzen
https://api.germanminer.de/v2/company/loan/set
Firmenname setzen
https://api.germanminer.de/v2/company/name/set

Eine Änderung über die API kostet wie im Bürgeramt auch 250 Euro.

Staatsfirmen-Verkaufsstatistiken einsehen
https://api.germanminer.de/v2/company/statecompany/stats

GMLINK

GM-Link
https://api.germanminer.de/v2/gmlink

Um einen Nutzer zu verifizieren, benötigst du die UUID, den GMLink-Code und einen Hash. Den GMLink-Code erhältst du durch den Spieler, welcher /gmlink im Chat eingeben muss. Der Hash muss ein MD5-Hash der IP-Adresse des Spielers sein.

PLAYER

Spielerinformationen
https://api.germanminer.de/v2/player/info

Gibt Informationen über den Inhaber des API-Schlüssels zurück.

PROTECTION

Sicherungsinformationen abrufen
https://api.germanminer.de/v2/protection/info
Spieler zur Sicherung hinzufügen
https://api.germanminer.de/v2/protection/player/add
Spieler von der Sicherung entfernen
https://api.germanminer.de/v2/protection/player/remove

WORLD

Truheninhalt löschen
https://api.germanminer.de/v2/world/clear/inventory

Die Truhe muss gesichert sein. Wenn der Parameter 'loadChunks' auf 'true' gesetzt ist, lädt der Server den Chunk, ansonsten wird ein Fehler zurückgegeben. Wenn ein Chunk geladen wird, werden zusätzlich 10 Anfragen von deinem Limit abgezogen.

Truheninhalt abrufen
https://api.germanminer.de/v2/world/inventory

Die Truhe muss gesichert sein. Wenn der Parameter 'loadChunks' auf 'true' gesetzt ist, lädt der Server den Chunk, ansonsten wird ein Fehler zurückgegeben. Wenn ein Chunk geladen wird, werden zusätzlich 10 Anfragen von deinem Limit abgezogen.

Item verschieben
https://api.germanminer.de/v2/world/move/item

Beide Truhen müssen gesichert sein und auf dem Selben Grundstück stehen. Wenn der Parameter 'loadChunks' auf 'true' gesetzt ist, lädt der Server den Chunk, ansonsten wird ein Fehler zurückgegeben. Wenn ein Chunk geladen wird, werden zusätzlich 20 Anfragen von deinem Limit abgezogen.