API-Version in Ihren Integrationen angeben
Erstellt für:
- Entwickler
Alle Adobe Workfront-URIs sollten auf eine bestimmte Version der API nach dem Teil „attask/api“ des URI verweisen. Im folgenden Beispiel wird Version 15.0 aufgerufen:
attask/api/v15.0/<objectName>/<objectId>
Stellen Sie sicher, dass alle Ihre Integrationen derzeit unterstützte Workfront-APIs aufrufen.
Zeitplan für Veröffentlichung und Einstellung von Workfront-APIs
Neue Versionen der API werden regelmäßig veröffentlicht, in der Regel zweimal jährlich. Jede Version wird drei Jahre nach dem Veröffentlichungsdatum unterstützt, wobei ein weiteres Jahr als veraltet gilt, in dem die Version verfügbar ist, aber nicht unterstützt wird.
Weitere Informationen zum Veröffentlichungsintervall und zur Planung der Einstellung von Workfront-APIs finden Sie unter API-Versionierung und Support-Zeitplan.
-
Die Standardversion der API ist auf die neueste Version festgelegt. Für jeden API-Aufruf ohne die angegebene Version wird die Standardversion verwendet. Jedes Mal, wenn Workfront eine neue Version der API veröffentlicht, wird die Standardversion auf die neueste Version aktualisiert. Daher sollten nach der Veröffentlichung einer neuen Version der Workfront-API alle API-Aufrufe, die die Standardversion verwenden, überprüft werden, um sicherzustellen, dass die Funktion weiterhin unterstützt wird.
-
Wenn Ihr Unternehmen derzeit die Standard-API verwendet, hat Ihr Workfront-Administrator eine Ankündigungscenter-Nachricht mit weiteren Anweisungen zur Standard-API erhalten.
Bestimmen der verwendeten API-Version
Sie können die verwendete API-Version ermitteln, indem Sie den URI einer HTTP-Anfrage überprüfen, die an die Workfront-API gesendet wird. 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 zum dynamischen Aktualisieren der API-Version und andere Eigenschaften, die sich ändern können (z. B. Ihren API-Schlüssel), einbeziehen.
Um die Aktualisierung von Integrationen effizienter zu gestalten, sollten Sie die folgenden Vorschläge für die Aufzeichnung von Integrationswerten berücksichtigen:
- Werte vorbehaltlich künftiger Änderungen in einer von Ihnen aktualisierten Eigenschaftendatei speichern
- Erstellen eines Web-Services zur Verwaltung von Eigenschaften in Echtzeit
- Speichern von Eigenschaftswerten in einem Datenspeicher, den Ihre Anwendung lesen kann
Wenn Sie Ihre Workfront-Integrationen unter diesem Gesichtspunkt entwerfen, müssen Sie keine umfangreichen Entwicklungsarbeiten durchführen, wenn sich diese Werte unweigerlich ändern.