REST-API

General

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 [e-mail] für zusätzliche Unterstützung kontaktieren.

Um unseren Service zu verbessern und Ihnen maßgeschneiderte API-Lösungen zu bieten, aktualisieren Sie bitte Ihre Infrastruktur, um dem aqua server die Annahme des Headers X-Api-Client zu ermöglichen.

Vorteile:

• Bessere Integration: Reibungslosere und zuverlässigere Verbindungen.

• Zukunftssicher: Skaliert mit Ihren Anforderungen.

• Benutzerdefinierte APIs: Maßgeschneidert für Ihre spezifischen Bedürfnisse.

• Festgelegte Versionierung und Stabilität: Gewährleistet Stabilität ohne breaking changes.

Erforderliche Maßnahmen:

Aktualisieren Sie Ihre Infrastruktur, damit der Aqua-Server den Header X-Api-Client akzeptiert. Bei Bedarf steht Ihnen unser Support-Team zur Verfügung.

Was passiert, wenn Sie nicht aktualisieren?

Es wird keine unmittelbare Auswirkung auf Ihre aktuelle Konfiguration haben. Die Zulassung dieses Headers wird uns jedoch in Zukunft dabei helfen, Ihre Erfahrung mit unserer API zu verbessern. Vielen Dank für Ihre Zusammenarbeit.