REST-API

Allgemeine Informationen

Wir bieten eine REST-API an. Sie können die API nutzen, um auf Informationen zu Items oder Testruns zuzugreifen, neue Items zu erstellen oder zu ändern, die Benutzerverwaltung zu managen, Testruns zu erstellen und vieles mehr.

Dies ermöglicht es Ihnen, wiederkehrende Aufgaben in aqua über Skripte zu automatisieren, große Datenmengen einfach zu handhaben (z. B. Tausende von Benutzern einem Projekt zuzuweisen) oder Schnittstellen zu Ihren Drittsystemen oder Automationstools zu erstellen.

Die REST-API ist ausführlich dokumentiert, mit Beispielen der Anfragen sowie der möglichen Antworten und Inhalte.

Als aqua OnPremises-Kunde finden Sie die Dokumentation auf der REST API-Hilfeseite unter:

http(s)://<IhrServernameOderIP>/aquaWebNG/Help

oder in einigen Fällen:

http(s)://<IhrServernameOderIP>/aquaWeb/Help

Bitte ersetzen <IhrServernameOderIP> mit Ihrem Servernamen oder der IP-Adresse des Servers.

Als aqua-SaaS-Kunde, bitte besuchen Sie die folgende Seite:

aqua REST API Help

Bitte beachten Sie auch Folgendes bei der Nutzung der REST

• Die Berechtigungen und Lizenzen des Benutzers, der sich in die REST-API einloggt, beeinflussen, was erlaubt ist. Beispielsweise kann man keinen Testfall mit der API erstellen, wenn der Benutzer keine Berechtigung zum Erstellen von Testfällen hat.

• Die ID der Elemente innerhalb der Anfragen muss ohne führende Nullen angegeben werden, z.B. 123 und nicht TC000123 oder 000123

Zugriff auf die Rest-API

Bitte folgen Sie den Anweisungen im Abschnitt 'Autorisierungen' unserer REST-API-Dokumentation, um Zugang zu erhalten.​

Wenn Sie JavaScript, Python oder PowerShell verwenden, um mit der REST-API zu kommunizieren, können Sie uns unter [email protected] für zusätzliche Unterstützung kontaktieren.

Um die Stabilität zu verbessern und Ihre Automatisierungs-Workflows zukunftssicher zu gestalten, führen wir in einigen Monaten eine neue öffentliche API ein. Diese neue API wird mit der aktuellen internen koexistieren, ist jedoch für höhere Stabilität ausgelegt und wird zukünftig unsere empfohlene Schnittstelle für externe Integrationen sein, da sich die interne API ohne Vorankündigung ändern kann.

Hier ist, was kommt

• 🧾Vorläufige Dokumentation steht Ihnen zur Verfügung, damit Sie alle verfügbaren Endpunkte überprüfen und mit Ihrer aktuellen Nutzung vergleichen können. Bitte laden Sie die Datei unten herunter.

• 🔐 Die Autorisierung ändert sich. Zukünftig müssen Sie bei jeder Anfrage den Authorization-Header mit dem Bearer-Token verwenden. Weitere Details folgen bald in der vollständigen Dokumentation .

• 🧪 Testumgebung. Wir bereiten eine spezielle Testumgebung für die neue API vor. Sie können Ihre Implementierung validieren, bevor sie live geht. Wir benachrichtigen Sie, sobald es fertig ist.

Was kommt als Nächstes?

Um sicherzustellen, dass alles reibungslos funktioniert, möchten wir Sie bitten, die Dokumentation zu prüfen und uns Ihre Fragen oder Ihr Feedback bis zum 23. Juni 2025 mitzuteilen. So haben wir genug Zeit, um vor der offiziellen Freigabe alle erforderlichen Anpassungen vorzunehmen.

Laden Sie die API Dokumentation herunter:

479KB

aqua-public-swagger.json

Für private Cloud- oder On Prem Benutzer:

Please review the documentation and provide us the feedback too. But you’ll have full control over when to upgrade to the version that includes the new API, so you can adapt at your own pace.