If you're not a professional developer and you're looking for more information about the Workfront API, this is the best place to start. The Get Started documentation is designed to familiarize you with Application Program Interfaces (APIs) while introducing you to the basic concepts of the Workfront object model and its documentation.
Familiarity with these basic concepts enables you to explore the deeper structures of the Workfront API and documentation. To reinforce your learning, there is a simple project included at the end of the section to walk you through the processes involved with creating some simple API requests, from start to finish.
Introduction to the Workfront API
Application Program Interfaces (APIs) facilitate communication between different programs and servers. Through the workfront API you can access, sort, and format information in ways that might not be readily accessible through a normal instance of Workfont.
REST Architecture
The Workfront API is structured under the standards of REST Architecture in order to make it easy to learn, simple to work with, and scalable.
Graphic User Interface (GUI) REST client
An API user interface (UI) is a tool that allows you to make requests to API servers and analyze their responses. A Graphic User Interface (GUI) REST client can simplify these processes by offering you a visual way to sort your requests and responses. The examples covered in the Getting Started documentation will be presented in a GUI REST client called Postman.
Authentication
In order to make requests and receive responses from the Workfront API, you must always have the proper credentials. There are several methods to obtain credentials and authenticate them with the API servers.
Requests
APIs work through a system of receiving requests and returning responses. Requests can be used to create new objects, read information about existing objects, make updates to an object, or delete an object.
Responses
The information returned through a response is the backbone for your reports and programs. It is important for you to know what information is being returned and how that information is organized so your programs can effectively utilize the response.
cURL
cURL is an industry standard tool that is used for building APIs.
Project
This guide will walk you through the process of making some simple request calls to the Workfront API