GermanMinerAPI Dokumentation

Version 1.1 - Aktualisiert am 16.01.2019

Erste Schritte

Um einen API-Schlüssel zu erhalten, öffnet man die Firmenverwaltungs-App und klickt auf das Icon mit dem Text „Entwicklerschnittstelle“. Dann klickt man auf „API-Schlüssel“, um den Schlüssel, der an die Firma gebunden ist zu erhalten. Der API-Server unter der URL https://api.germanminer.de akzeptiert sowohl GET als auch POST Anfragen mit jeweils dem key und dem request Parameter.

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 Schlüssel success auf true gesetzt ist, denn ansonsten ist bei der Anfrage etwas schiefgelaufen. Der Fehler kann jeweils durch den Wert error einfach ausgegeben werden.

Anfragenlimits

Unter dem Punkt „Anfragenlimits“ der Firmenverwaltungs-App kann man sehen, wie viele Anfragen man pro Stunde senden kann, wie viele bereits gesendet wurden und wann die Anfragen zurückgesetzt werden. Das Limit der anfragen kann aber auch manuell mit der Formel %FIRMENLEVEL%^2*60 berechnet werden. Achte besonders darauf, dass du nicht zu viele Anfragen in einer kurzen Zeit schickst, denn ansonsten kann dies in einer Sperrung des API-Schlüssels resultieren.

Verfügbare Funktionen

GET GMLink
https://api.germanminer.de/?key={KEY}&request=gmlink/{UUID}/{CODE}/{HASH}
Hinweis: 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.
GET Firmeninformationen abrufen
https://api.germanminer.de/?key={KEY}&request=firma/info
POST Firmenbeschreibung ändern
https://api.germanminer.de/?key={KEY}&request=firma/beschreibung
Post: {"data": "{BESCHREIBUNG}"}
GET Kontoauszug abrufen
https://api.germanminer.de/?key={KEY}&request=firma/kontoauszug
GET Staatsfirmen-Verkaufsstatistiken
https://api.germanminer.de/?key={KEY}&request=firma/staatsfirmenverkaufsstatistiken
GET FirmenShop-Verkaufsstatistiken
https://api.germanminer.de/?key={KEY}&request=firma/firmenshopsstatistiken
GET Überweisungen tätigen
https://api.germanminer.de/?key={KEY}&request=firma/ueberweisung/{KONTONUMMER}/{BETRAG}
GET Mitarbeiter kündigen
https://api.germanminer.de/?key={KEY}&request=firma/kuendingen/{UUID}
GET Mitarbeitergehalt ändern
https://api.germanminer.de/?key={KEY}&request=firma/gehalt/{UUID}/{BETRAG}