Integrationen aktualisieren, die die Standard-API-Versionierung verwenden

Letzte Aktualisierung: 31. Dezember 2024
  • Themen:

Erstellt für:

  • Entwickler

Wir veröffentlichen alle zwei Jahre neue Versionen der Adobe Workfront-API. Jede Version wird drei Jahre nach ihrer Veröffentlichung unterstützt, wobei ein weiteres Jahr als veraltet gilt, in dem die Version verfügbar ist, aber nicht unterstützt wird.

Integrationen, die keine Version der API im URI angeben, werden automatisch auf den Standard weitergeleitet. Wenn Sie möchten, dass Ihr API-Aufruf eine bestimmte Version der API verwendet, müssen Sie diese Version in Ihren Workfront-API-Anfragen angeben.

HINWEIS
Wenn Ihr Unternehmen derzeit die Standard-API verwendet, hat Ihr Workfront-Administrator eine Ankündigungscenter-Nachricht mit weiteren Anweisungen zur Standard-API erhalten.

Informationen zur Angabe einer Version in Ihren API-Anfragen finden Sie unter Angeben einer API-Version in Ihren Integrationen.

Überlegungen zur Verwendung der Standard-API

Beachten Sie beim Arbeiten mit der Workfront-Standard-API Folgendes:

  • Die Standardversion der API ist die neueste Version. 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 veraltete Standard-API verwendet, hat Ihr Workfront-Administrator eine Ankündigungscenter-Nachricht mit weiteren Anweisungen zur Standard-API erhalten.

Die neueste Version der API finden Sie unter API-Versionierung und Support-Zeitplan.

Aktualisieren Ihrer Integrationen auf unterstützte API-Versionen

Wenn in den Workfront-API-Anfragen keine Version angegeben ist, wird die Standardversion verwendet. Es wird empfohlen, in API-Anfragen eine unterstützte Version der API anzugeben, vorzugsweise für die neueste unterstützte API.

Die folgende Workfront-API-Anfrage gibt beispielsweise keine API-Version an:

https://davidwhite.my.workfront.com/attask/api/project/metadata

Wenn diese Anfrage erfolgt, erhalten Sie eine Antwort mit JSON-kodiertem Text, der Daten aus Ihrer Workfront-Instanz angibt. Da in diesem URI keine API-Version angegeben ist, wird der Aufruf an „Default“ (Standard) gesendet.

Um eine Standard-API-Anfrage in eine versionierte API-Anfrage umzuwandeln, rufen Sie einfach eine unterstützte API-Version auf. Beispielsweise fordert der folgende URI Version 15 an:

https://davidwhite.my.workfront.com/attask/api/v15.0/project/metadata

Beim Aktualisieren Ihrer Workfront-API-Anfragen können Sie eine beliebige unterstützte Version Ihrer API angeben. Weitere Informationen zum Referenzieren einer bestimmten API finden Sie unter API-Version in Ihren Integrationen angeben.

Um das maximale Support-Fenster zu ermitteln, sollten Sie die neueste Version aufrufen. Eine Liste der unterstützten APIs finden Sie unter API-Versionierung und Support-Zeitplan.

Verlauf der Standardversion der API

Die ursprüngliche Absicht der „Standard-API“, oder „Standard“, war es, sie der neuesten Version der Workfront-API zuzuordnen. Dies würde es Kunden mit grundlegenden Integrationen, die als Standard bezeichnet werden, ermöglichen, ihre API-Anfragen nie zu aktualisieren.

2011 veröffentlichte Workfront Version 3.0 der API. Die Standardeinstellung wurde automatisch auf Version 3.0 verschoben, was viele Kundenintegrationen beschädigte, die zu komplex waren, um Version 3.0 zu verwenden, ohne aktualisiert zu werden. Infolgedessen hat Workfront diese Änderung rückgängig gemacht und die Standardversion bei Version 2 belassen.

Seit 2011 hat Workfront die API-Funktionalität erheblich erweitert. Aus diesem Grund werden ältere Versionen unserer API nicht mehr unterstützt. Im Jahr 2017 haben wir das Konzept einer Standardversion vollständig entfernt, anstatt Default zu aktualisieren. Dies sollte unsere Kunden ermutigen, stabile Versionen unserer APIs zu verwenden und ihre Integrationen über einen Zyklus von höchstens drei Jahren zu pflegen.

Workfront stellt jetzt die Standard-API-Version wieder her. Die Standard-API ist auf die neueste Version der Workfront-API festgelegt und wird bei jeder Veröffentlichung einer neuen Version auf die neueste Version aktualisiert.

Vorherige SeiteVerfügbare Zeit für Benutzer abrufen
Nächste SeiteNachrichten zu Ereignisabonnements filtern

Workfront