Genesis API Überblick

Die Genesis-Plattform stellt eine REST API über HTTPS bereit. Jede Anfrage wird an eine Basis‑URL gesendet, mit einem Token im Anfrage‑Header authentifiziert und liefert JSON.

Basis‑URL

https://api.nxgen.cloud/api/v1

Jeder Pfad auf diesen Seiten ist relativ zu ihr: GET /user/me bedeutet GET https://api.nxgen.cloud/api/v1/user/me.

Authentifizierung

Anfragen enthalten ein Token im auth-token Header. Siehe Authentication für die Beschaffung eines Tokens.

Ressourcen

Konventionen

• Pfadparameter werden in geschweiften Klammern geschrieben, /site/{id}. Ersetzen Sie den gesamten Platzhalter, einschließlich der Klammern.
• Request‑Bodies sind JSON, sofern nicht anders angegeben. Auf diesen Seiten wird ein Body als Skelett dargestellt: die Feldnamen mit dem erwarteten Typ anstelle jedes Wertes, und (required) bei den Feldern, die vorhanden sein müssen.
• Antworttabellen listen jeden Status auf, den die Spezifikation deklariert. 401 bedeutet, dass das Token fehlte oder abgelehnt wurde; 403bedeutet, dass es gültig war, aber keinen Zugriff auf die Ressource hatte.

Spezifikation Version 1.0.0.