KeyHelp Community

Alexander wrote: ↑Fri 27. Sep 2019, 14:58 Nicht wundern, ich bereite die Server doch erst am Montagmorgen vor. Bis dahin können sich aber trotzdem noch gern Test-Willige melden.

Tobi wrote: ↑Sun 20. Oct 2019, 22:11 Zunächst einmal ein dickes Lob. DIe neue API ist der Hammer. Es macht damit Spaß zu arbeiten und endlich können DInge "direkt" realisiert werden welche vorher nur mit Gefrickel möglich waren. Ich freue mich schon darauf mit der API zu arbeiten, denn diese wird definitiv meinen Arbeitsalltag erleichtern. Außerdem macht sie den Weg frei für Third-Part-Software für KeyHelp. Es werden spannende Zeiten!

Tobi wrote: ↑Sun 20. Oct 2019, 22:11 Je nach verwendeter Methode reagiert "/domains/{id}" anders.

Tobi wrote: ↑Sun 20. Oct 2019, 22:11 Erstens und wirklich (zumindest für mich) unerlässliche Ergänzung an der API => Endpoint /domain
Kannst du da bitte noch den Parameter "skeleton" hinzufügen?

Tobi wrote: ↑Sun 20. Oct 2019, 22:11 Zweitens, Wichtigkeit Medium
Ich persönlich finde den API Key sehr "kurz". Wünschen würde ich mir eine Mindest-Schlüssellänge von 512 Bit, besser gleich 1024.

Tobi wrote: ↑Sun 20. Oct 2019, 22:11 Drittens, Rückgabewert "Aktion erfolgreich"
Kann man bei der erfolgreichen Verarbeitung auch (analog zu den Fehlern) einen Statuscode (idealerweise als INT) übermitteln?
Aktuell gibt es beispielsweise folgenden Rückgabewert

Code: Select all

"code": "400 Bad Request",

Ich stelle mir eine globale Erweiterung der API vor.
Als numerischer Wert.

Code: Select all

"statuscode": 400,

und im Erfolgsfall

Code: Select all

"statuscode": 200,

Das würde das Auswerten des Rückgabewertes standardisieren.

Tobi wrote: ↑Sun 20. Oct 2019, 22:11 Viertens, API Namensraum
Am Beispiel "/domains".
Je nach verwendeter Methode reagiert "/domains/{id}" anders. Könnte man hier noch folgende Alias vergeben?

Code: Select all

/domains/detail/id [GET] ===> /domains/{id} [GET]
/domains/update/id [POST] ===> /domains/{id} [PUT]
/domains/delete/id [GET] ===> /domains/{id} [DELETE]

Ich finde meine Endpointbezeichner "merkbarer" und selbsterklärend. Aber gut, das ist vielleicht einfach nur Geschmackssache.

Tobi wrote: ↑Sun 20. Oct 2019, 22:11 Fünftens, Client-Overview
Quasi eine Zusammenfassung der Werte von "/clients/{id}/domains" bis "/clients/{id}/ftp-users". Im Grunde wie der Punkt "resources" bei /server
Das kann oder sollte an /clients/{id} [GET] (oder neu /clients/detail/id [GET] ) angehängt werden. "resources" trifft es auf den Punkt. Am besten inklusive aller Domainnamen (nicht nur die Anzahl).

Tobi wrote: ↑Sun 20. Oct 2019, 22:11 Sechstens, Serverinfo
Kann man im Bereich "meta" noch IPV4 / IPV6 - Adresse hinzufügen?
Bei "operating_system" noch "eol" 1 oder 0 ergänzen? Das würde die Überwachung mehrer Server vereinfachen.
Ebenso ein "updates_in_queue". Quasi "Ausstehende Updates" für diesen Server.
"uptime" wäre auch noch ein wünschenswerter Wert.

"meta": {
        ...
        "ip_addresses": [
            "62.141...",
            "62.141..."
        ],
        ...
        "uptime": {
            "days": 80,
            "hours": 3,
            "minutes": 8,
            "seconds": 33
        },
        ...
]

"operating_system": {
        ...
        "end_of_life": false,
        "updates": {
            "update_count": 0,
            "security_update_count": 0,
            "reboot_required": true
        }
}

Alexander wrote: ↑Mon 21. Oct 2019, 14:34

Tobi wrote: ↑Sun 20. Oct 2019, 22:11 Fünftens, Client-Overview
Quasi eine Zusammenfassung der Werte von "/clients/{id}/domains" bis "/clients/{id}/ftp-users". Im Grunde wie der Punkt "resources" bei /server
Das kann oder sollte an /clients/{id} [GET] (oder neu /clients/detail/id [GET] ) angehängt werden. "resources" trifft es auf den Punkt. Am besten inklusive aller Domainnamen (nicht nur die Anzahl).

Hier würde ich gern noch eine Nacht drüber schlafen (Feedback zum Thema wäre willkommen):
Ich würde dann die Endpunkte "/clients/{id}/domains" bis "/clients/{id}/ftp-users" entfernen, und stattdessen einen Punkt "/clients/{id}/resources" hinzufügen, über den man wie durch Tobi beschrieben sämtliche Ressourcen zurückgegeben bekommt. Wenn man bestimmte Angaben nicht braucht, könnte man sie mittels GET Query-Parameter ausblenden, z.B. "?databases=0&ftp_users=0" (sie beim Endpunkt "/server/").

Alexander wrote: ↑Mon 21. Oct 2019, 14:34 @Enigma,
Habe den zweiten Teil deines Beitrags auf meine ToDo-Liste gesetzt.

Alexander wrote: ↑Mon 21. Oct 2019, 14:34 Könntest du bis dahin trotzdem was mit der API anfangen, bzw. dir Übergangsweise noch anders behelfen?

Ich habe gerade keine Zeit zum Testen, daher frage ich einfach mal: Beim Anlegen einer Domain gibt es deutlich mehr Optionen als beim Updaten, z. B. php_version, is_disabled, delete_on, is_dns_disabled, is_email_domain sowie die HSTS-Einstellungen. Jedenfalls laut Doku... Ist die Doku da nur unvollständig oder kann ich diese prinzipiell nachträglich zu ändernden Optionen tatsächlich nicht per API anpassen?

Alexander wrote: ↑Thu 24. Oct 2019, 08:23

Es gibt nur die Möglichkeit zu definieren, ob ein Feld readOnly (GET)

Deswegen also DELETE /domains und nicht GET /domains/delete/id

Das wird echt Klasse mit dem nächsten Update und ich finde es toll wie Alex auf Wünsche und Ideen reagiert!