Spécification d’une version d’API dans vos intégrations
Tous les URI Adobe Workfront doivent référencer une version spécifique de l’API après la partie "tâche/api" de l’URI. L’exemple suivant appelle la version 15.0 :
attask/api/v15.0/<objectName>/<objectId>
Vérifiez que toutes vos intégrations appellent les API Workfront actuellement prises en charge.
Calendrier des versions et des obsolescences des API Workfront
Les nouvelles versions de l’API sont publiées régulièrement, généralement deux fois par an. Chaque version est prise en charge pendant trois ans après sa date de publication, avec une année supplémentaire dans un état obsolète où la version est disponible mais pas prise en charge.
Pour plus d’informations sur la cadence de publication et la planification de la dépréciation des API Workfront, voir Contrôle de version des API et planning de prise en charge.
-
La version par défaut de l’API est définie sur la version la plus récente. Tout appel API sans la version spécifiée utilise la version par défaut. Chaque fois que Workfront publie une nouvelle version de l’API, la version par défaut est mise à jour vers la dernière version. Par conséquent, après la publication d'une nouvelle version de l'API Workfront, tous les appels d'API qui utilisent la version par défaut doivent être vérifiés pour s'assurer que la fonctionnalité est toujours prise en charge.
-
Si votre entreprise utilise actuellement l’API par défaut, votre administrateur Workfront a reçu un message du centre d’annonces contenant des instructions supplémentaires sur l’API par défaut.
Détermination de la version d’API que vous utilisez
Vous pouvez déterminer la version de l’API que vous utilisez en vérifiant l’URI d’une requête HTTP envoyée à l’API Workfront. L’exemple suivant illustre un URI de demande Workfront qui spécifie la version 15 de l’API :
https://<domainname>.my.workfront.com/attask/api/v15.0/proj/4c7c08b20000002de5ca1ebc19edf2d5
Si un URI ne spécifie pas de version, il utilise la version par défaut de l’API, comme illustré dans l’exemple suivant :
https://<domainname>.my.workfront.com/attask/api/proj/4c7c08b20000002de5ca1ebc19edf2d5
Mise à jour des intégrations pour utiliser les versions d’API prises en charge
Lorsque vous créez ou gérez des intégrations Workfront, vous devez inclure une méthode pour mettre à jour dynamiquement la version de l’API et d’autres propriétés susceptibles d’être modifiées (telles que votre clé d’API).
Pour rendre la mise à jour des intégrations plus efficace, tenez compte des suggestions suivantes pour enregistrer les valeurs d’intégration :
- Stocker les valeurs sujettes à de futures modifications dans un fichier de propriétés que vous conservez à jour
- Créer un service Web pour gérer les propriétés en temps réel
- Stocker les valeurs de propriété dans un entrepôt de données que votre application peut lire
La conception de vos intégrations Workfront à cet effet permet d’éviter un travail de développement intensif lorsque ces valeurs changent inévitablement.