Codebeamer Nutzungsrichtlinien für Swagger APIs
Bevor Sie Codebeamer APIs verwenden, sollten Sie die folgenden Richtlinien lesen, um eine konforme und effektive Integration zu gewährleisten. Bei Befolgung dieser Empfehlungen werden die Risiken im Zusammenhang mit nicht unterstützten oder nicht dokumentierten APIs minimiert und eine zuverlässige, sichere und konforme Nutzung dieser APIs sichergestellt.
1. Partner- und Kundenverantwortlichkeiten:
◦ Bestätigen und API-Zugriffslizenz anfordern.
Partner und Kunden müssen die Notwendigkeit des Erwerbs einer KI-bezogenen Lizenz für APIs klar verstehen und ausdrücklich kommunizieren. Dies ist ein obligatorischer Schritt, um die von der Plattform bereitgestellten KI-Funktionen legal und effektiv zu nutzen. Ohne diese Lizenz können Sie KI-Funktionalitäten nicht in Ihre Lösungen integrieren.
2. Unterstützte APIs:
◦ Eine vollständige Liste der unterstützten Swagger-APIs finden Sie unter <siteURL>/v3/swagger/editor.spr.
Sie müssen die angegebene URL verwenden, um auf die vollständige Liste der unterstützten APIs zuzugreifen. Diese Liste ist wichtig, um sicherzustellen, dass Sie APIs verwenden, die offiziell verwaltet und unterstützt werden.
◦ Es wird dringend empfohlen, Swagger-APIs für alle Neuentwicklungen zu verwenden.
Swagger-APIs werden aufgrund ihrer robusten Dokumentation und des laufenden Supports für Neuimplementierungen empfohlen.
◦ Die REST API (v1) wird weiterhin gepflegt, aber nicht mehr aktiv weiterentwickelt.
Die REST-API (v1) wird zwar weiterhin unterstützt, ist sie für die Neuentwicklung aber veraltet. Da für sie keine weitere Entwicklung geplant ist, gilt die Swagger-API als die bevorzugte Wahl für zukunftssichere Lösungen.
3. Lizenzierungs- und Nutzungsbeschränkungen:
◦ Verwenden Sie nur dokumentierte und unterstützte APIs.
◦ Interne oder nicht unterstützte APIs können ohne vorherige Bekanntgabe geändert werden und zu Integrationsfehlern, Ausfallzeiten, Inkompatibilität oder Verzögerungen bei der Einführung neuer Produktversionen führen. Die Verwendung solcher APIs ist aufgrund dieser Unvorhersehbarkeit riskant.
4. Nicht unterstützte APIs verwenden:
a. Die Verwendung von nicht dokumentierten oder internen APIs wird von PTC nicht unterstützt. Die Verwendung solcher APIs ohne ausdrückliche Genehmigung und Lizenz stellt einen Verstoß gegen PTC Vereinbarungen dar.
Es wird davon abgeraten, nicht dokumentierte oder interne APIs zu verwenden, da diese von PTC nicht unterstützt werden. Die Verwendung solcher APIs kann zu erheblichen Problemen führen und wird daher nicht empfohlen.
Die Verwendung nicht dokumentierter oder interner APIs kann zu Folgendem führen:
i. Der Kundensupportvertrag erlischt.
Die Verwendung von APIs ohne die erforderlichen Lizenzen und Berechtigungen verstößt gegen die PTC Benutzervereinbarung und kann den Supportvertrags ungültig machen.
ii. Dazu zählt das Extrahieren von Daten zum Trainieren von KI-Modellen oder das Erstellen von Datenquellen ohne ausdrückliche schriftliche Genehmigung von PTC.
b. Systeme Leistungs- oder Sicherheitsrisiken aussetzen
i. Nicht unterstützte APIs wurden möglicherweise nicht strengen Tests unterzogen, einschließlich Leistungs- und Sicherheitstests, was sie zu potenziellen Schwachstellen in Ihrem System macht. Die Verwendung solcher APIs führt zu Schwachstellen und Leistungsrisiken im System, die seine Zuverlässigkeit und Sicherheit beeinträchtigen.
c. Derartige APIs können die Zugriffssteuerung umgehen, was zu einem Verlust an Datenintegrität und -zuverlässigkeit führt.
Nicht unterstützte APIs können etablierte Zugriffssteuerungsmechanismen umgehen, was zu Beeinträchtigungen der Datenintegrität und -zuverlässigkeit führen kann. Dies stellt ein erhebliches Risiko für das Gesamtsystem dar.
d. Riskieren Schutzrechtsverletzungen, da diese APIs Eigentum von PTC sind.
i. Die Nutzung nicht unterstützter APIs kann zu potenziellen Problemen aufgrund der Verletzung von Rechten des geistigen Eigentums führen, da diese APIs Teil des geistigen Eigentums von PTC sind.
Die Verwertung nicht unterstützter APIs kann zu Problemen aufgrund der Verletzung von Rechten des geistigem Eigentums führen, da diese APIs Teil des geistigen Eigentums von PTC sind. Eine unbefugte Nutzung kann ein rechtliches Nachspiel haben und ist zu vermeiden.
5. Benutzerberechtigungen
Der authentifizierte Benutzer muss:
◦ Teil einer Benutzergruppe mit Berechtigung REST/Remote-API - Zugriff sein.
◦ Mindestens die Leseberechtigung für die angeforderte Ressource im angeforderten Status haben.
6. Integrierten API-Tester verwenden
Der integrierte API-Tester ist unter
<site url>/v3/swagger/editor.spr verfügbar. Weitere Informationen zur Verwendung des integrierten API-Testers finden Sie unter
Swagger-API verwenden.
7. Swagger-Client generieren
Erstellen Sie mit dem Codebeamer GitHub Repository einen Swagger-Client, um die clientseitige Code-Integration zu optimieren und zu vereinfachen. Weitere Informationen finden Sie unter
Swagger-Client generieren.
8. Geeignete Authentifizierung verwenden
Codebeamer unterstützt drei Arten von Authentifizierungsmethoden für den Zugriff auf die API. Weitere Informationen zur von Swagger unterstützten Authentifizierungsmethode finden Sie unter
Authentifizierung.