API-Version in Ihren Integrationen angeben
Alle Adobe Workfront-URIs sollten auf eine bestimmte Version der API nach dem "attask/api"-Teil des URI verweisen. Im folgenden Beispiel wird Version 15.0 aufgerufen:
attask/api/v15.0/<objectName>/<objectId>
Stellen Sie sicher, dass alle Integrationen die derzeit unterstützten Workfront-APIs aufrufen.
Veröffentlichungs- und Veraltungsplan für Workfront-APIs
Neue Versionen der API werden regelmäßig veröffentlicht, in der Regel zweimal jährlich. Jede Version wird drei Jahre nach ihrem Veröffentlichungsdatum unterstützt, wobei ein zusätzliches Jahr veraltet ist und die Version zwar verfügbar, aber nicht unterstützt wird.
Weitere Informationen zum Veröffentlichungsintervall und zur Einstellung der Verwendung von Workfront-APIs finden Sie unter API-Versionierung und Support-Zeitplan.
-
Die Standardversion der API wird auf die neueste Version festgelegt. Für jeden API-Aufruf ohne die angegebene Version wird die Standardversion verwendet. Jedes Mal, wenn Workfront eine neue API-Version veröffentlicht, wird die Standardversion auf die neueste Version aktualisiert. Daher sollten nach Veröffentlichung einer neuen Version der Workfront-API alle API-Aufrufe, die die Standardversion verwenden, überprüft werden, um sicherzustellen, dass die Funktionalität weiterhin unterstützt wird.
-
Wenn Ihr Unternehmen derzeit die Standard-API verwendet, hat Ihr Workfront-Administrator eine Mitteilung zum Ankündigungszentrum mit weiteren Anweisungen zur Standard-API erhalten.
Bestimmen der verwendeten API-Version
Sie können die Version der verwendeten API ermitteln, indem Sie den URI einer an die Workfront-API gesendeten HTTP-Anfrage überprüfen. Das folgende Beispiel zeigt einen Workfront-Anfrage-URI, der Version 15 der API angibt:
https://<domainname>.my.workfront.com/attask/api/v15.0/proj/4c7c08b20000002de5ca1ebc19edf2d5
Wenn ein URI keine Version angibt, verwendet er die Standardversion der API, wie im folgenden Beispiel gezeigt:
https://<domainname>.my.workfront.com/attask/api/proj/4c7c08b20000002de5ca1ebc19edf2d5
Aktualisieren von Integrationen zur Verwendung unterstützter API-Versionen
Beim Erstellen oder Verwalten von Workfront-Integrationen sollten Sie eine Methode zur dynamischen Aktualisierung der API-Version und anderer Eigenschaften einschließen, die geändert werden können (z. B. Ihren API-Schlüssel).
Um die Aktualisierung von Integrationen effizienter zu gestalten, sollten Sie die folgenden Vorschläge für die Aufzeichnung von Integrationswerten berücksichtigen:
- Store-Werte, die künftigen Änderungen in einer Eigenschaftendatei unterliegen, die Sie aktualisieren
- Erstellen Sie einen Webdienst, um Eigenschaften in Echtzeit zu verwalten
- Store-Eigenschaftswerte in einem Datenspeicher, den Ihre Anwendung lesen kann
Durch die Konzeption Ihrer Workfront-Integrationen mit diesem Ziel wird die Notwendigkeit umfangreicher Entwicklungsarbeiten entlastet, wenn sich diese Werte unweigerlich ändern.