API Document Webhooks

Dernière mise à jour : 21 mai 2025
  • Rubriques :

Créé pour :

  • Développeur

Adobe Workfront Document Webhooks définit un ensemble de points d’entrée d’API par le biais desquels Workfront effectue des appels API autorisés à un fournisseur de documents externe. Cela permet à n’importe qui de créer un plug-in d’intergiciel pour n’importe quel fournisseur de stockage de documents.

L’expérience utilisateur des intégrations basées sur les webhooks sera similaire à celle des intégrations de documents existantes telles que Google Drive, Box et Dropbox. Par exemple, un utilisateur ou une utilisatrice de Workfront pourra effectuer les actions suivantes :

  • Naviguer dans la structure des dossiers du fournisseur de documents externes
  • Rechercher des fichiers
  • Lier des fichiers à Workfront
  • Charger des fichiers vers le fournisseur de documents externes
  • Afficher une miniature du document

Implémentation de référence

Pour aider à démarrer le développement d’une nouvelle implémentation de webhooks, Workfront fournit une implémentation de référence. Le code correspondant se trouve à l’adresse suivante : https://github.com/Workfront/webhooks-app. Cette implémentation est basée sur Java et permet à Workfront de connecter des documents sur un système de fichiers en réseau.

Enregistrement d’une intégration de webhook

Les administrateurs et administratirces Workfront peuvent ajouter une intégration de webhook personnalisée pour leur société en naviguant vers Configuration > Documents > Intégrations personnalisées dans Workfront. À partir de la page Intégration personnalisée de la configuration, les administrateurs et administratrices peuvent afficher une liste des intégrations de webhook de documents existantes. Cette page permet d’ajouter, de modifier, d’activer et de désactiver des intégrations. Pour ajouter une intégration, cliquez sur le bouton Ajouter une intégration .

Champs disponibles

Lors de l’ajout d’une intégration, l’administrateur ou administratrice saisit des valeurs pour les champs suivants :

Nom du champDescription
NomNom de cette intégration.
URL API de baseEmplacement de l’API de rappel. Lors d’appels au système externe, Workfront ajoute le nom du point d’entrée à cette adresse. Par exemple, si l’administrateur ou administratrice a saisi l’URL de l’API de base, « https://www.mycompany.com/api/v1 », Workfront utilisera l’URL suivante pour obtenir les métadonnées d’un document : https://www.mycompany.com/api/v1/metadata?id=1234.
Paramètres de requêteLes valeurs optionnelles à ajouter à la chaîne de requête de chaque appel API. Par exemple, access_type
Type d'authentificationOAuth2 ou ApiKey.
URL d'authentification(OAuth2 uniquement) L’URL complète utilisée pour l’authentification de l’utilisateur ou utilisatrice. Workfront dirige les utilisateurs vers cette adresse dans le cadre du processus d’approvisionnement OAuth.

Remarque : Workfront ajoute un paramètre « state » à la chaîne de requête. Le fournisseur doit le renvoyer à Workfront en l’ajoutant à l’URI de redirection de Workfront.
URL de jeton de point d’entrée(OAuth2 uniquement) L’URL d’API complète utilisée pour récupérer les jetons OAuth2. Il est hébergé par le fournisseur webhook ou le fournisseur de documents externe.
ID client(OAuth2 uniquement) Identifiant du client OAuth2 pour cette intégration.
Clé secrète client(OAuth2 uniquement) Secret client OAuth2 pour cette intégration.
URI de redirection Workfront(OAuth2 uniquement) Ce champ est en lecture seule et est généré par Workfront. Cette valeur est utilisée pour enregistrer cette intégration auprès du fournisseur de documents externes.

Remarque : comme décrit ci-dessus pour l’URL d’authentification, le fournisseur doit ajouter le paramètre « state » et sa valeur à la chaîne de requête lors de l’exécution de la redirection.
ApiKey(ApiKey uniquement) Utilisé pour effectuer des appels API autorisés vers le fournisseur de webhooks. La clé API est émise par le fournisseur webhook.