Getting Started
The documentation for Workfront API's is an incredible resource to help you know the ins and outs of the REST-ful Workfront API's. It is recommended to review all tabs and links associated there to give you the best understanding of how the API works and will give you the solid foundation needed to plan and built a robust integration.
All the methods made available to users of the API are on the Workfront API Explorer.
We have provided a Postman collection to help you to get started quickly to authenticate and start making calls to the Workfront API.
Requirements
1. Access to a Workfront Environment
2. Workfront user with the correct access level for API's
3. Proficiency in RESTful architecture
4. Understanding of the JSON data format
5. Basic experience using Postman
Authentication
Please download the postman collection, as well as environment before proceeding. You will find them as attachments at the bottom of this article
The following environment variables can be found using the following link. Be sure to follow the JWT flow.
https://experienceleague.adobe.com/en/docs/workfront/using/administration-and-setup/configure-integrations/create-oauth-application
- Client ID
- Client Secret
- Public Key / Private Key
- Customer ID,
- Customer User,
Base Url (Your environment name e.g. example.my.workfront.com)
After filling the Environment variables, run these calls in the Postman collection...
- Authentication Get call (Init: Load Crypto Library)
- AUTH: Generate Workfront JWT and Access Token
These two calls should auto populate the next environment variables - jsrsasign-js, JWT Token and Access Token.
Endpoint
After Authenticating, here are some example endpoints you can call.
Example templates:
{{BaseURL}}/attask/api/{{ApiVersion}}/Project/{{ObjectURI}}
{{BaseURL}}/attask/api/{{ApiVersion}}/Task/{{ObjectURI}}
{{BaseURL}}/attask/api/{{ApiVersion}}/Issue/{{ObjectURI}}
Where {{BaseURL}} Is the URL of your Workfront Instance, and the {{ApiVersion}} and the {{ObjectURI}} can be found via the workfront API explorer.
Example endpoint for listing all Projects:
https://example.my.workfront.com/attask/api/v17.0/Project/search