Die Nimbuscloud-API.

• Schnittstellen — Die Nimbuscloud ist über die JSON-Schnittstellen (Current und Legacy) erreichbar. Beide werden laufend weiterentwickelt und gepflegt, neue Softwaremodule erhalten jedoch nur Endpunkte in der aktuellen API.
• Legacy-Dokumentation — Die Dokumentation der Legacy-API findest du hier.
• API-Keys — Sofern der Zugriff auf die API im gewählten Paket enthalten ist, können API-Keys in der Nimbuscloud unter System > Einstellungen > API-Keys erstellt werden.
• IP-Beschränkung — API-Keys können aus Sicherheitsgründen auf bestimmte IP-Adressen eingeschränkt werden. Ist keine Einschränkung gewünscht, kann der Zugriff mit einem Stern (*) von jeder beliebigen IP-Adresse erfolgen.
• Undokumentierte Felder — Felder, die über diese Dokumentation hinaus übertragen werden, sind nicht offiziell verfügbar und können ohne Vorankündigung umbenannt oder entfernt werden.
• Deprecation — Aufrufe an einen veralteten Endpunkt werden mit einer Warnung im Log markiert. Der Zeitpunkt der Abkündigung ist in der Dokumentation des jeweiligen Endpunkts angegeben.
• Support — Technischer Support ist ausschließlich über Support-Ticket oder per E-Mail an support@nimbuscloud.at verfügbar und wird individuell abgerechnet.

• API-Key-Header — Der API-Key muss im Header X-API-Key übergeben werden.
• Berechtigungen — Die erforderlichen API-Key-Berechtigungen sind in der Dokumentation des jeweiligen Endpunkts angegeben. Es gibt 3 Anforderungsstufen:

  • All — Alle angezeigten Berechtigungen sind erforderlich.
  • Any — Eine beliebige der angezeigten Berechtigungen ist erforderlich.
  • Single — Nur die eine angezeigte Berechtigung ist erforderlich.
• Zugriffsprotokollierung — Zugriffe auf die API, die aufgrund fehlender Berechtigungen oder einer nicht übereinstimmenden IP-Adresse eingeschränkt wurden, werden im Systemlog protokolliert.
• JSON-Struktur — Alle Daten werden in JSON-Objekten innerhalb eines übergeordneten Schlüssels data gesendet und empfangen. Ausnahmen gelten für binäre Antworten oder Anfragen.
• Zeichenkodierung — Alle Daten müssen UTF-8-kodiert sein.
• Zeitstempel — Zeitstempel müssen als lokale Zeit übergeben werden. Unter Tools ist ein Timestamp-Konverter zu finden.
• Datumsformat — Daten werden im PHP-Format Date_ATOM übermittelt (Beispiel: 2005-08-15T15:52:01+00:00).
• Pagination — Paginierte Antworten enthalten die Daten in der Eigenschaft items. Die Pagination-Informationen werden in den Eigenschaften totalItemCount, pageStart (Offset) und pageSize (Standard: 10, max. 1000) übermittelt.

1 · GET-Request

$client = new GuzzleHttpClient();

try {
    $response = $client->get("https://xyz.nimbuscloud.at/backend/v2/user/auth/sso/dashboard-iframe-token-info", [
        RequestOptions::HEADERS => [
            "Content-Type" => "application/json",
            "X-API-Key" => "yourapikey"
        ],
        RequestOptions::QUERY => [
            "token" => $token
        ]
    ]);
    $response = json_decode($response->getBody()->getContents(), true);
    var_dump($response);
} catch (GuzzleHttpExceptionGuzzleException $e) {
    echo $e->getMessage();
}

2 · POST-Request

try {
    $client = new GuzzleHttpClient();
    $response = $client->post("https://xyz.nimbuscloud.at/backend/v2/user/auth/sso/create-login-token", [
        RequestOptions::HEADERS => [
            "Content-Type" => "application/json",
            "X-API-Key" => "yourapikey"
        ],
        RequestOptions::BODY => json_encode([
            "data" => [
                "applicationName" => ...,
                "forwardUrl" => ...,
                "cancelUrl" => ...,
            ]
        ])
    ]);
    $response = json_decode($response->getBody()->getContents(), true);
    $link = $response["data"]; //data contains the result
} catch (GuzzleHttpExceptionClientException $e) {
    if($e->getCode() === 404) {
        echo "Result hat error code 404!";
    }
    else {
        echo $e->getMessage();
    }
}