Document Webhooks-API
Erstellt für:
- Entwickler
Adobe Workfront Document Webhooks definiert einen Satz von API-Endpunkten, über die Workfront autorisierte API-Aufrufe an einen externen Dokumentanbieter sendet. Dadurch kann jeder ein Middleware-Plug-in für einen beliebigen Dokumentspeicheranbieter erstellen.
Das Benutzererlebnis bei Webhook-basierten Integrationen ähnelt dem von vorhandenen Dokumentenintegrationen, z. B. Google Drive, Box und Dropbox. Beispielsweise kann ein Workfront-Benutzer die folgenden Aktionen ausführen:
- Navigieren in der Ordnerstruktur des externen Dokumentanbieters
- Dateien durchsuchen
- Verknüpfen von Dateien mit Workfront
- Hochladen von Dateien in den externen Dokumentanbieter
- Anzeigen einer Miniaturansicht für das Dokument
Referenzimplementierung
Um die Entwicklung einer neuen Webhooks-Implementierung zu beschleunigen, stellt Workfront eine Referenzimplementierung bereit. Code dafür finden Sie unter https://github.com/Workfront/webhooks-app. Diese Implementierung basiert auf Java und ermöglicht es Workfront, Dokumente in einem Netzwerk-Dateisystem zu verbinden.
Registrieren von Webhook-Integrationen
Workfront-Administratoren können eine benutzerdefinierte Webhook-Integration für ihr Unternehmen hinzufügen, indem sie in Workfront zu Einrichtung > Dokumente > Benutzerdefinierte Integrationen navigieren. Auf der Seite „Benutzerdefinierte Integration“ im Setup können Admins eine Liste der vorhandenen Dokument-Webhook-Integrationen anzeigen. Auf dieser Seite können Integrationen hinzugefügt, bearbeitet, aktiviert und deaktiviert werden. Um eine Integration hinzuzufügen, klicken Sie auf die Schaltfläche Integration hinzufügen .
Verfügbare Felder
Beim Hinzufügen einer Integration gibt der Administrator Werte für die folgenden Felder ein:
| Feldname | Beschreibung |
|---|---|
| Name | Der Name dieser Integration. |
| Basis-API-URL | Der Speicherort der Callback-API. Beim Aufrufen des externen Systems hängt Workfront den Endpunktnamen an diese Adresse an. Wenn der Administrator beispielsweise die Basis-API-URL https://www.mycompany.com/api/v1 eingegeben hat, ruft Workfront die Metadaten eines Dokuments über die folgende URL ab: https://www.mycompany.com/api/v1/metadata?id=1234. |
| Anfrageparameter | Optionale Werte, die an die Abfragezeichenfolge eines jeden API-Aufrufs anzuhängen sind. Beispiel: access_type=offline. |
| Authentifizierungstyp | OAuth2 oder API-Schlüssel. |
| Authentifizierungs-URL | (Nur OAuth2) Die vollständige URL, die für die Benutzerauthentifizierung verwendet wird. Workfront führt Benutzer im Rahmen des OAuth-Bereitstellungsprozesses zu dieser Adresse. Hinweis: Workfront hängt einen Parameter „state“ an die Abfragezeichenfolge an. Der Anbieter muss dies zurück an Workfront übergeben, indem er es an den Workfront-Umleitungs-URI anhängt. |
| Token Endpoint URL | (Nur OAuth2) Die vollständige API-URL, die zum Abrufen von OAuth2-Token verwendet wird. Dies wird vom Webhook-Anbieter oder externen Dokumentanbieter gehostet. |
| Client-ID | (Nur OAuth2) Die OAuth2-Client-ID für diese Integration. |
| Geheimer Client-Schlüssel | (Nur OAuth2) Der geheime OAuth2-Client-Schlüssel für diese Integration. |
| Workfront-Umleitungs-URI | (Nur OAuth2) Dies ist ein schreibgeschütztes Feld, das von Workfront generiert wird. Dieser Wert wird verwendet, um diese Integration beim externen Dokumentanbieter zu registrieren. Hinweis: Wie oben für die Authentifizierungs-URL beschrieben, muss der Anbieter den Parameter „state“ und dessen Wert an die Abfragezeichenfolge anhängen, wenn er die Umleitung durchführt. |
| ApiKey | (Nur API-Schlüssel) Wird verwendet, um autorisierte API-Aufrufe an den Webhook-Anbieter durchzuführen. Der API-Schlüssel wird vom Webhook-Anbieter ausgegeben. |
Authentifizierung
Workfront-Dokument-Webhooks unterstützen zwei verschiedene Authentifizierungsformen: OAuth2 und ApiKey. In beiden Fällen übergibt Workfront bei einem API-Aufruf Authentifizierungs-Token in der -Kopfzeile.
OAuth2
Mit OAuth2 kann Workfront im Namen eines Benutzers autorisierte API-Aufrufe an einen Webhook-Anbieter durchführen. Zuvor muss der/die Benutzende sein externes Konto beim Dokumentanbieter mit Workfront verbinden und Workfront Zugriff gewähren, damit er/sie in seinem/ihrem Namen handeln kann. Dieser Handshaking-Vorgang erfolgt für jeden Benutzer nur einmal. So funktioniert es:
-
Der Benutzer beginnt mit dem Verbinden der Webhook-Integration mit seinem Konto. Klicken Sie dazu auf die Dropdown-Liste Dokument hinzufügen > Service hinzufügen > Benutzerdefinierter Integrationsname.
-
Workfront führt den Benutzer zur Authentifizierungs-URL, wodurch der Benutzer möglicherweise aufgefordert wird, sich beim externen Dokumentanbieter anzumelden. Diese Seite wird vom Webhook-Anbieter oder dem externen Document Management-System gehostet. Dabei fügt Workfront der Authentifizierungs-URL einen Parameter „state“ hinzu. Dieser Wert muss zurück an Workfront übergeben werden, indem im folgenden Schritt derselbe Wert an den Workfront-Rückgabe-URI angehängt wird.
-
Nach der Anmeldung beim externen System (oder wenn der Benutzer bereits angemeldet ist) wird der Benutzer zu einer Authentifizierungsseite weitergeleitet, auf der erklärt wird, dass Workfront Zugriff anfordert, um eine Reihe von Aktionen im Namen des Benutzers auszuführen.
-
Wenn der/die Benutzende auf die Schaltfläche Zulassen klickt, wird der Browser zum Workfront-Umleitungs-URI weitergeleitet, wobei der Abfragezeichenfolge „code=
<code>" hinzugefügt wird. Gemäß der OAuth2-Spezifikation ist dieses Token kurzlebig. Die Abfragezeichenfolge muss außerdem Folgendes enthalten: „state=<sent_by_workfront>". -
Workfront verarbeitet diese Anfrage und führt einen API-Aufruf an die Token-Endpunkt-URL mit dem Autorisierungs-Code durch.
-
Die Token-Endpunkt-URL gibt ein Aktualisierungs-Token und ein Zugriffs-Token zurück.
-
Workfront speichert diese Token und stellt die Webhook-Integration für diesen Benutzer bereit.
-
Ab diesem Zeitpunkt kann Workfront autorisierte API-Aufrufe an den Webhook-Anbieter durchführen. Bei diesen Aufrufen sendet Workfront das Zugriffstoken in der HTTP-Anfrage-Kopfzeile wie unten dargestellt:
------------------------------- Authorization: Bearer [access_token] ------------------------------- -
Wenn das Zugriffstoken abgelaufen ist, führt Workfront einen Aufruf an die Token-Endpunkt-URL durch, um ein neues Zugriffstoken abzurufen, und versucht dann den autorisierten API-Aufruf mit dem neuen Zugriffstoken erneut.
ApiKey
Die Durchführung autorisierter API-Aufrufe an einen Webhook-Anbieter mithilfe eines APIkeys ist viel einfacher als OAuth2. Wenn Sie einen API-Aufruf ausführen, übergibt Workfront einfach den API-Schlüssel und den Workfront-Benutzernamen in der HTTP-Anfrage-Kopfzeile:
-------------------------------
apiKey: 12345
username: johndoe@foo.com
-------------------------------
Der Webhook-Anbieter kann den Benutzernamen verwenden, um benutzerspezifische Berechtigungen anzuwenden. Dies funktioniert am besten, wenn beide Systeme über Single Sign-On (SSO) eine Verbindung zu LDAP herstellen.
Hinzufügen von Anfrage-Headern (optional)
Zusätzlich zur Verwendung von OAuth2-Token oder eines API-Schlüssels zur Authentifizierung kann Workfront für jeden API-Aufruf einen vordefinierten Satz von Kopfzeilen an den Webhook-Anbieter senden. Ein Workfront-Administrator kann dies beim Registrieren oder Bearbeiten einer Webook-Integration wie im obigen Abschnitt beschrieben einrichten.
Dies kann beispielsweise für die Standardauthentifizierung verwendet werden. Dazu fügt der Workfront-Administrator die folgenden Anfrage-Header-Informationen im Dialogfeld für die benutzerdefinierte Integration hinzu:
Zulassung Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
wobei QWxhZGRpbjpvcGVuIHNlc2FtZQ== eine base-64-kodierte Zeichenfolge von „username:password“ ist. Siehe Standardauthentifizierung. Sofern dies hinzugefügt wurde, übergibt Workfront dies zusätzlich zu anderen Anfrage-Headern in der HTTP-Anfrage-Kopfzeile:
-------------------------------
apiKey: 12345
username: johndoe@foo.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
-------------------------------
API-Spezifikation
Nachfolgend finden Sie eine Liste der APIs, die der Webhook-Anbieter implementieren sollte, damit Dokument-Webhooks funktionieren.
Abrufen von OAuth2-Token (nur OAuth2-Authentifizierung erforderlich)
Gibt das OAuth2-Aktualisierungs-Token und Zugriffs-Token für einen authentifizierten Benutzer zurück. Dieser wird einmal aufgerufen, wenn der Benutzer einen Dokumentanbieter bereitstellt. Nachfolgende Aufrufe erfolgen, um ein aktualisiertes Zugriffstoken abzurufen.
HTTP-POST-Anfrage /any/url
Die URL ist konfigurierbar und entspricht dem Token-Endpunkt-URL-Wert auf der Seite „Benutzerdefiniertes Integrations-Setup“.
Abfrageparameter
Antwort
Beispiel
POST /oauth2/token
grant_type=authorization_code
code=d9ac7asdf6asdf579d7a8
client_id=123456
client_secret=6asdf7a7a9a4af
Antwort
{
"access_token":"ad8af5ad5ads759",
"refresh_token":"9a0h5d87d808ads",
"expires_id":"3600"
}
Abrufen von Metadaten für Datei oder Ordner
Gibt Metadaten für die angegebene Datei oder den angegebenen Ordner zurück.
URL
GET /metadata?id=[document or folder ID]
Abfrageparameter
Die ID einer Datei oder eines Ordners, auf die bzw. den der Webhook-Anbieter verweist. Dies unterscheidet sich von der Dokument-ID von Workfront. Um die Metadaten des Stammverzeichnisses abzurufen, verwenden Sie den Wert "/".
Hinweis: Die maximale Länge für die ID beträgt 255 Zeichen.
Antwort
Beispiel: https://www.acme.com/api/metadata?id=12345
Antwort
{
"title":"My Document",
"kind":"file"
"id":"12345",
"viewLink":"https://www.acme.com/viewDocument?id=12345",
"downloadLink":"https://www.acme.com/downloadDocument?id=12345",
"mimeType":"image/png",
"dateModified":"20140605T17:39:45.251Z",
"size": "32554694"
}
NOTEAbrufen einer Liste von Elementen in einem Ordner
Gibt Metadaten für die Dateien und Ordner für einen bestimmten Ordner zurück.
URL
GET /files
Abfrageparameter
Die Document Webhooks-API unterstützt derzeit nicht die Paginierung.
Antwort
JSON mit einer Liste von Dateien und Ordnern. Die Metadaten für jedes Element sind dieselben, die vom Endpunkt /metadata zurückgegeben werden.
Beispiel: https://www.acme.com/api/files?parentId=123456
Antwort
[
{
"title":"Folder A",
"kind":"folder",
"id":"2lj23lkj",
"viewLink":"https://www.acme.com/viewDocument?id=2lj23lkj",
"downloadLink":"https://www.acme.com/downloadDocument?id=2lj23lkj",
"mimeType":"",
"dateModified":"20140605T17:39:45.251Z",
"size":""
},
{
"title":"My Document",
"kind":"file",
"id":"da8cj234"
"viewLink":"https://www.acme.com/viewDocument?id=da8cj234",
"downloadLink":"https://www.acme.com/downloadDocument?id=da8cj234",
"mimeType":"image/png",
"dateModified":"20140605T17:39:45.251Z",
"size":"32554694"
},
]
Suche durchführen
Gibt Metadaten für die bei einer Suche zurückgegebenen Dateien und Ordner zurück. Dies kann als Volltextsuche oder als reguläre Datenbankabfrage implementiert werden. Workfront ruft den /search-Endpunkt auf, wenn der Benutzer eine Suche über den externen Dateibrowser durchführt.
URL
GET /search
Abfrageparameter
Hinweis: Dies ist ein Platzhalter für eine zukünftige Funktion in Workfront. Dieser Parameter wird von Workfront derzeit nicht übergeben.
Die Document Webhooks-API unterstützt derzeit nicht die Paginierung.
Antwort
JSON mit einer Liste von Metadaten für Dateien und Ordner, die mit der Abfrage übereinstimmen. Was eine „Übereinstimmung“ darstellt, wird vom Webhook-Anbieter bestimmt. Idealerweise sollte dies eine Volltext- oder Dateinamensuche sein.
Beispiel: https://www.acme.com/api/search?query=test-query
Antwort
[
{ File/Folder Metadata },
{ File/Folder Metadata }
]
Abrufen des Inhalts eines Dokuments
Gibt die rohen Bytes für ein Dokument zurück.
URL
GET /download
Abfrageparameter
Antwort
Die Rohbytes des Dokuments.
Beispiel: https://www.acme.com/api/download?id=123456
Abrufen einer Miniaturansicht für ein Dokument
Gibt die rohen Miniaturbyte für ein Dokument zurück.
URL
GET/Thumbnail
Abfrageparameter
Antwort
Die rohen Miniaturansichten in Bytes.
Beispiel: https://www.acme.com/api/thumbnail?id=123456
Datei hochladen - Teil 1 von 2
Das Hochladen einer Datei in einen Dokumentspeicheranbieter ist ein zweistufiger Prozess, für den zwei separate API-Endpunkte erforderlich sind. Workfront beginnt den Upload-Prozess mit dem Aufruf von /uploadInit . Dieser Endpunkt gibt eine Dokument-ID zurück, die beim Hochladen der Dokument-Bytes an /upload übergeben wird. Je nach dem zugrunde liegenden Dokumentenspeichersystem kann es erforderlich sein, ein Dokument mit einer Länge von null zu erstellen und den Inhalt des Dokuments dann später zu aktualisieren.
In Version 1.1 dieser Spezifikation können die Dokument-ID und Dokumentversions-ID hinzugefügt werden, um zusätzliche Informationen von Workfront abzurufen. Wenn das Dokumentenverwaltungssystem beispielsweise zusätzliche Informationen zum Dokument benötigt, könnte der Webhook-Implementierungs-Code die Dokument-ID verwenden, um diese Informationen mithilfe der RESTful-API von Workfront abzurufen. Als Best Practice empfiehlt es sich, diese Informationen aus benutzerdefinierten Datenfeldern im Dokument und in den zugehörigen Vorgängen, Problemen oder Projekten zu generieren.
URL
POST/uploadInit
Abfrageparameter
Antwort
Die Metadaten für die Datei, wie vom Endpunkt /metadata definiert.
Beispiel: https://www.acme.com/api/uploadInit?parentId=12345&filename=new-file.png&docu mentId=511ea6e000023edb38d2effb2f4e6e3b&documentVersionId=511ea6e000023edb38d2e ffb2f4e6e3b
Antwort
[file_metadata] enthält die neue Dokument-ID, die vom Dokumentanbieter verwendet wird.
Datei hochladen - Teil 2 von 2
Lädt die Bytes eines Dokuments in den Webhook-Anbieter hoch.
URL
PUT/Upload
Abfrageparameter
Anfragetext
Die Rohdaten-Inhaltsbytes für das Dokument.
Antwort
{
"result": "success"
}
oder
{
"result": "fail"
}
Beispiel: https://www.acme.com/api/upload?id=1234 [Dokument-Bytes im Aktualisierungsverlauf enthalten]
Antwort
{
"result":"success"
}
Abrufen von Informationen über den Service
(Veröffentlichungsdatum - wird noch bekannt gegeben) Gibt Informationen zum Service zurück, z. B. Funktionen und Merkmale. Workfront verwendet diese Informationen, um die Benutzeroberfläche in Workfront anzupassen. Wenn die Webhook-Implementierung beispielsweise benutzerdefinierte Aktionen enthält, sollte die JSON diese Vorgänge in der JSON-Datei auflisten. Benutzer können dann diese Aktionen von Workfront aus aufrufen.
URL
GET /serviceInfo
Abfrageparameter
Keine. Darüber hinaus sollten Aufrufe an diesen Endpunkt keine Authentifizierung erfordern.
Antwort
JSON mit Informationen zu diesem Service.
Beispiel: https://www.acme.com/api/serviceInfo
Rückgabe
{
"webhook version": "1.2", "version": "1.0", "publisher": "Acme, LLC", "availableEndpoints": ["files", "metadata", "search", "download"
"thumbnail", "uploadInit", "upload" ], "customActions" [
{
"name": "archive", "displayName": "Archive" }, {
"name": "doSomethingElse", "displayName": "Do Something" }, ] }
Erstellen eines Ordners
(In Version 1.2 hinzugefügt) Erstellt einen Ordner in einem bestimmten Verzeichnis.
URL
POST/createFolder
Abfrageparameter
Antwort
Die Metadaten für den neu erstellten Ordner, wie vom Endpunkt /metadata definiert.
Beispiel: POST https://www.acme.com/api/createFolder
-------------------------------
parentId=1234
name=New Folder
-------------------------------
Rückgabe
{"title":"New Folder",
"kind":"folder""id":"5678",
"viewLink":"",
"downloadLink":"",
"mimeType":"",
"dateModified":"20140605T17:39:45.251Z"
"size": ""
}
Dokument oder Ordner löschen
(Veröffentlichungsdatum - wird noch bekannt gegeben) Löscht ein Dokument oder einen Ordner mit der angegebenen ID im externen System. Beim Löschen eines Ordners wird auch dessen Inhalt gelöscht.
URL
PUT/Löschen
Abfrageparameter
Antwort Eine JSON-Zeichenfolge, die Erfolg oder Fehler angibt, wie im Abschnitt Fehlerbehandlung unten angegeben.
Beispiel: PUT https://www.acme.com/api/delete id=1234
Rückgabe
{
"status": "success"
}
Rückgabe
{
"status": "failure", "error": "File not found"
}
Dokument oder Ordner umbenennen
(Veröffentlichungsdatum - wird noch bekannt gegeben) Benennt ein Dokument oder einen Ordner mit der angegebenen ID im externen System um.
URL
PUT/Umbenennen
Abfrageparameter
Antwort
Eine JSON-Zeichenfolge, die Erfolg oder Fehler anzeigt, wie im Abschnitt Fehlerbehandlung unten angegeben.
Beispiel:
PUT https://www.acme.com/api/rename
-------------------------------
id=1234
name=Folder B
-------------------------------
{
"status": "success"
}returns
{
"status": "failure", error: "Folder cannot be renamed because a folder with that name already exists."
}
Durchführen einer benutzerdefinierten Aktion
(Veröffentlichungsdatum - wird noch bekannt gegeben) Dieser Endpunkt ermöglicht es einem Workfront-Benutzer (oder vielleicht einem automatisierten Workflow-Ereignis), eine Aktion im externen System durchzuführen. Der /customAction-Endpunkt akzeptiert einen „name“-Parameter, mit dem der Webhook-Anbieter mehrere benutzerdefinierte Vorgänge implementieren kann.
Der Webhook-Anbieter registriert benutzerdefinierte Aktionen bei Workfront, indem er die Aktionen in die /serviceInfo-Antwort unter customActions aufnimmt. Workfront lädt diese Liste, wenn Sie den Webhook-Anbieter unter Einrichtung > Dokumente > Benutzerdefinierte Integrationen einrichten oder aktualisieren.
Benutzerinnen und Benutzer können Trigger zur benutzerdefinierten Aktion erstellen, indem sie den Abschnitt unter Dokumentaktionen auswählen.
URL
GET /customAction
Abfrageparameter
Antwort
Eine JSON-Zeichenfolge, die Erfolg oder Fehler anzeigt, wie im Abschnitt Fehlerbehandlung unten angegeben. Bei einem Fehler (d. h. Status = „Fehler„) zeigt Workfront dem Benutzer die bereitgestellte Fehlermeldung an.
Beispiel: https://sample.com/webhooks/customName?name=archive&documentId=5502082c003a4f30 ddec2fb2b739cb7c&documentVersionId=54b598a700e2342d6971597a5df1a8d3
Antwort
{
"status": "success"
}
Fehlerbehandlung
Bei der Verarbeitung von API-Anfragen können Probleme auftreten. Dies sollte über alle API-Endpunkte hinweg konsistent gehandhabt werden. Wenn ein Fehler auftritt, führt der Webhook-Anbieter Folgendes aus:
-
Fügen Sie einen Fehlercode in die Antwortkopfzeile ein. Zu den Fehlercodes gehören:
- 403 - Verboten. Gibt an, dass entweder die Anfrage-Token fehlen oder ungültig sind oder dass mit den Token verknüpfte Anmeldeinformationen keinen Zugriff auf die angegebene Ressource haben. Bei OAuth-basierten Webhook-Anbietern versucht Workfront, neue Zugriffstoken abzurufen.
- 404 - Nicht gefunden. Gibt an, dass die angegebene Datei oder der angegebene Ordner nicht vorhanden ist.
- 500 - Interner Server-Fehler. Jede andere Fehlerart.
-
Beschreiben Sie den Fehler im Antworttext im folgenden Format:
{
"status": "error"
"error": "Sample error message"
}
Testen
Um sicherzustellen, dass die Webhook-Implementierung des Dokuments ordnungsgemäß funktioniert, führen Sie die folgenden Tests aus. Hierbei handelt es sich um manuelle Tests, die die Workfront-Web-Schnittstelle durchlaufen und indirekt die Endpunkte für Ihre Webhook-Implementierung treffen.
Voraussetzungen
Um diese Tests auszuführen, benötigen Sie Folgendes:
- Ein Workfront-Konto mit aktiviertem Advanced Document Management (ADM).
- Ein Workfront-Benutzer für dieses Konto mit Systemadministratorrechten.
- Eine Document Webhook-Instanz, deren HTTP-Endpunkte für Workfront zugänglich sind.
Bei diesen Tests wird außerdem davon ausgegangen, dass Sie Ihre Document Webhook-Instanz in Workfront unter Setup > Dokumente > Benutzerdefinierte Integrationen bereits registriert haben.
Test 1: Bereitstellen des Document Webhook-Service für einen Benutzer
Testet die Authentifizierungs-URL und Token-Endpunkt-URL für OAuth-basierte Webhook-Anbieter.
- Navigieren Sie in Workfront zur Hauptseite Dokumente , indem Sie in der oberen Navigationsleiste auf den Link Dokumente klicken.
- Klicken Sie auf die Dropdown-Liste Dokumente hinzufügen und wählen Sie unter Service hinzufügen Ihren Document Webhook-Service aus.
- (Nur OAuth-Services) Nach Abschluss des vorherigen Schritts wird die OAuth2-Authentifizierungsseite Ihres Services in einem Popup-Fenster geladen. (Hinweis: Sie werden möglicherweise aufgefordert, sich zuerst bei Ihrem Dienst anzumelden.) Gewähren Sie auf der Authentifizierungsseite Workfront Zugriff auf das Konto des Benutzers, indem Sie auf die Schaltfläche Trust oder Allow klicken.
- Stellen Sie sicher, dass Ihr Dienst zur Dropdown-Liste Dokumente hinzufügen hinzugefügt wurde. Wenn Sie sie anfangs nicht sehen, versuchen Sie, Ihren Browser zu aktualisieren.
Test 2: Verknüpfen eines Dokuments mit Workfront Testet die folgenden Endpunkte: /files, /metadata
- Navigieren Sie in Workfront zur Hauptseite Dokumente , indem Sie in der oberen Navigationsleiste auf den Link Dokumente klicken.
- Wählen Sie Ihren Document Webhook-Service unter Dokumente hinzufügen aus.
- Navigieren Sie im Modal durch die Ordnerstruktur.
- Stellen Sie sicher, dass Sie in der Lage sind, ordnungsgemäß durch die Ordnerstruktur zu navigieren.
- Ein Dokument auswählen und mit Workfront verknüpfen.
Test 3: Navigieren zu einem Dokument im Content-Management-System
Testet die folgenden Endpunkte: /metadata (insbesondere den viewLink).
- Verknüpfen eines Dokuments mit Workfront.
- Wählen Sie das Dokument aus und klicken Sie auf den Link Öffnen .
- Stellen Sie sicher, dass das Dokument auf einer neuen Registerkarte geöffnet wird.
Test 4: Navigieren Sie zu einem Dokument im Content Management System (mit Anmeldung)
Testet die folgenden Endpunkte: /metadata (insbesondere den viewLink).
- Stellen Sie sicher, dass Sie vom Content-Management-System abgemeldet sind.
- Verknüpfen eines Dokuments mit Workfront.
- Wählen Sie das Dokument aus und klicken Sie auf den Link Öffnen .
- Stellen Sie sicher, dass der Anmeldebildschirm des Content Management Systems auf einer neuen Registerkarte geladen wird.
- Melden Sie sich an und stellen Sie sicher, dass Sie zum Dokument weitergeleitet werden.
Test 5: Herunterladen des Dokuments aus dem Content-Management-System
Testet die folgenden Endpunkte: /metadata (speziell den downloadLink).
- Verknüpfen eines Dokuments mit Workfront.
- Wählen Sie das Dokument aus und klicken Sie auf den Link Herunterladen .
- Stellen Sie sicher, dass der Download beginnt.
Test 6: Suchen nach Inhalten
Testet die folgenden Endpunkte: /search
- Navigieren Sie in Workfront zur Hauptseite Dokumente , indem Sie in der oberen Navigationsleiste auf den Link Dokumente klicken.
- Wählen Sie Ihren Document Webhook-Service unter Dokumente hinzufügen aus.
- Führen Sie über das Modal eine Suche durch.
- Überprüfen Sie, ob die Suchergebnisse korrekt sind.
Test 7: Senden eines Dokuments von Workfront an das Content Management System
Testet die folgenden Endpunkte: /files, /uploadInit, /upload
- Navigieren Sie in Workfront zur Hauptseite Dokumente , indem Sie in der oberen Navigationsleiste auf den Link Dokumente klicken.
- Laden Sie ein Dokument von Ihrem Computer in Workfront hoch.
- Navigieren Sie zur Seite mit den Dokumentdetails.
- Wählen Sie aus der Dropdown-Liste Dokumentaktionen unter Senden an… Ihren Dokument-Webhook-Service aus.
- Wechseln Sie zum gewünschten Zielordner und klicken Sie auf die Schaltfläche Speichern .
- Überprüfen Sie, ob das Dokument an den richtigen Speicherort im Content Management System hochgeladen wurde.
Test 8: Anzeigen von Miniaturansichten in Workfront
Testet die folgenden Endpunkte: /thumbnail
- Verknüpfen eines Dokuments mit Workfront.
- Wählen Sie das Dokument in der Liste aus.
- Stellen Sie sicher, dass die Miniaturansicht im rechten Bedienfeld angezeigt wird.
Test 9: Abrufen der Inhalts-Bytes
Testet die folgenden Endpunkte: /download
- Verknüpfen eines Dokuments mit Workfront.
- Navigieren Sie zur Seite mit den Dokumentdetails.
- Senden Sie das Dokument an Workfront, indem Sie Dokumentaktionen > Senden an… > Workfront auswählen. Dadurch wird eine neue Dokumentversion in Workfront erstellt.
- Laden Sie das Dokument von Workfront herunter, indem Sie auf den Download-Link klicken.
Test 10: Zugriffstoken aktualisieren (nur OAuth2-Webhook-Anbieter)
Testet die folgenden Endpunkte: Token Endpoint URL
- Bereitstellen des Document Webhook-Services für einen Benutzer.
- Invalidierung des Zugriffs-Tokens des Benutzers, indem entweder darauf gewartet wird, dass eine Zeitüberschreitung eintritt, oder indem es im externen System manuell invalidiert wird.
- Aktualisieren Sie das Zugriffstoken in Workfront. Dies können Sie beispielsweise tun, indem Sie ein Dokument mit Workfront verknüpfen. Das Zugriffstoken wurde erfolgreich aktualisiert, wenn Sie zu einem Dokument navigieren und es verknüpfen konnten.
NOTEVersionen
-
Version 1.0 (Veröffentlichungsdatum - Mai 2015)
- Erstspezifikation
-
Version 1.1 (Veröffentlichungsdatum - Juni 2015)
- /uploadInit - Dokument-ID und Dokument-Version-ID hinzugefügt
-
Version 1.2 (Veröffentlichungsdatum - Oktober 2015)
- Hinzugefügt /createFolder