Een API-versie opgeven in uw integratie
Alle Adobe Workfront URI's moeten verwijzen naar een specifieke versie van de API na het gedeelte "attask/api" van de URI. In het volgende voorbeeld wordt versie 15.0 aangeroepen:
attask/api/v15.0/<objectName>/<objectId>
Zorg ervoor dat al uw integratieaanroepen momenteel ondersteunde Workfront API's bevatten.
Release- en implementatieschema van Workfront API's
Nieuwe versies van de API worden regelmatig uitgebracht, meestal twee keer per jaar. Elke versie wordt ondersteund gedurende drie jaar na de releasedatum, met een extra jaar in een vervangen toestand waarin de versie beschikbaar maar niet ondersteund is.
Zie voor meer informatie over het schema voor het afbreken en afgekeuren van Workfront API's API-versieschema en ondersteuningsschema.
-
De standaardversie van de API wordt ingesteld op de meest recente versie. Voor elke API-aanroep zonder de opgegeven versie wordt de standaardversie gebruikt. Elke keer dat Workfront een nieuwe versie van de API loslaat, wordt de standaardversie bijgewerkt naar de nieuwste versie. Daarom moeten, nadat een nieuwe versie van de Workfront API is uitgebracht, alle API-aanroepen die de standaardversie gebruiken, worden gecontroleerd om ervoor te zorgen dat de functionaliteit nog steeds wordt ondersteund.
-
Als uw organisatie momenteel de standaard-API gebruikt, heeft uw Workfront-beheerder een bericht van het Aankondigingscentrum ontvangen met verdere instructies betreffende de standaard-API.
De API-versie bepalen die u gebruikt
U kunt de versie van de API bepalen die u gebruikt door de URI te controleren van een HTTP-aanvraag die naar de Workfront API wordt verzonden. In het volgende voorbeeld wordt een Workfront request-URI getoond die versie 15 van de API opgeeft:
https://<domainname>.my.workfront.com/attask/api/v15.0/proj/4c7c08b20000002de5ca1ebc19edf2d5
Als een URI geen versie opgeeft, wordt de standaardversie van de API gebruikt, zoals in het volgende voorbeeld wordt getoond:
https://<domainname>.my.workfront.com/attask/api/proj/4c7c08b20000002de5ca1ebc19edf2d5
Integraties bijwerken voor gebruik van ondersteunde API-versies
Wanneer u Workfront-integratie maakt of onderhoudt, moet u een methode opnemen voor het dynamisch bijwerken van de API-versie en andere eigenschappen die kunnen worden gewijzigd (zoals de API-sleutel).
Om het bijwerken van integraties efficiënter te maken, zou u de volgende suggesties voor het registreren van integratiewaarden moeten overwegen:
- Waarden opslaan die in de toekomst worden gewijzigd in een eigenschappenbestand dat u bijwerkt
- Een webservice maken om eigenschappen in real-time te beheren
- Eigenschapwaarden opslaan in een gegevensopslagruimte die uw toepassing kan lezen
Door uw Workfront-integratie met dit in gedachten te ontwerpen, verlicht u de behoefte aan uitgebreide ontwikkelingswerkzaamheden wanneer deze waarden onvermijdelijk veranderen.