API Controller Console Manual
Aus EUserv Wiki
| Languages: |
Deutsch |
API Controller Konsolen Handbuch
Inhaltsverzeichnis |
Programmvorbereitung
Konfiguration anlegen
Um das Programm verwenden zu können müssen Sie zunächst eine Konfigurationsdatei anlegen, dazu können Sie die im Installationsverzeichnis bereits enthaltene Datei „config.ini“ verwenden. Kopieren Sie die Datei in das Verzeichnis von dem aus Sie das Programm starten möchten, öffnen Sie sie und tragen Sie hinter „name=“ den Benutzernamen ihres API-Benutzers ein, hinter „pass=“ das dazugehörige Passwort. Hinter dem Parameter „serv“ geben Sie an ob Sie das Live- oder Sandbox-System der API verwenden möchten. Tragen Sie dazu entweder „Livesystem“ oder „Sandbox“ ein. Alternativ können Sie auch andere Dateien zur Konfiguration verwenden, mehr dazu erfahren Sie im Abschnitt Zusatzparameter - config_file
Konfiguration testen
Bevor Sie Ihre Daten in die Konfigurationsdatei eintragen können Sie sie mit folgendem Befehl testen. Öffnen Sie dazu zunächst Ihre Konsole und wechseln Sie in das Verzeichnis der „apicmd.exe“. Geben Sie dann folgende Zeile ein:
apicmd.exe "check_login" "'serv'=>'[Ihr gewünschtes System]'; 'name'=>'[Der Name des API-Benutzers]'; 'pass'=>'[Das Passwort des Benutzers]';"
Befehlssyntax
API-Befehle
Ein Übersicht aller API-Befahle finden Sie in der Dokumentation.
Um einen API-Befehl auszuführen geben Sie ihn in folgender Form an und ersetzen die Klammer durch die für den gewünschten Befehl spezifischen Daten.
apicmd.exe "[Name des API-Befehls]" "'[Name des Parameters]'=>'[Wert des Parameters]'; '[weiterer Parameter]'=>'[weiterer Wert]';"
Achten Sie bei der Eingabe besonders auf die Hochkomma vor und nach jedem Parameter bzw. Wert.
Bitte beachten Sie, dass nur mit der aktuellen Version des API Controllers Befehle erfolgreich an den Server gesendet werden können. Nutzen Sie den Befehl „update_client“ um Ihr Programm falls nötig zu aktualisieren.
Programm-Befehle
Neben den API - Befehlen existieren einige Kommandos zur Steuerung des Programms selbst welche hier näher erläutert werden
check_login
Dieser Befehl dient zum Test der Benutzerdaten. War der Verbindungsversuch erfolgreich wird „Connection successful!“ in der Konsole ausgegeben.
Parameter:
- serv
- Gibt an auf welchem API - Server sie arbeiten möchten, mögliche Werte sind: „Livesystem“ und „Sandbox“
- name
- Ihr API - Benutzername
- pass
- Das Passwort des entsprechenden API - Benutzers
check_client_version
Dieser Befehl ermittelt ob eine neue Programmversion zur Verfügung steht und gibt diese aus.
update_client
Mit diesem Befehl kann die neuste Programmversion heruntergeladen werden. Wurde eine aktuellere Version gefunden und ist diese erfolgreich heruntergeladen wird das Setup automatisch gestartet.
Zusatzparameter
Die hier aufgelisteten Parameter können nur vom API-Controller verwendet werden und sind deshalb nicht in der API-Dokumentation beschrieben. Sie bieten zusätzliche Möglichkeiten die API-Befehle zu steuern. Um die Parameter zu verwenden geben Sie nach dem ersten Parameterblock begrenzt von „“ einen zweiten in gleicher Form an.
config_file
Dieser Parameter kann bei jedem API-Befehl verwendet werden. Als Wert wird der Pfad zu einer Konfigurationsdatei erwartet. Die Datei muss jedoch den Inhalt der Datei „config.ini“, im Installationsverzeichnis, enthalten.
output_file
Dieser Parameter kann für den Befehl „server.get_graph“ verwendet werden. Als Parameter wird wird der Pfad einer Ausgabedatei erwartet. Anders als in der Dokumentation beschrieben wird der Graph nicht verschlüsselt ausgegeben sondern direkt in das PNG Format übersetzt und kann somit angezeigt werden
