workfront-api

A client for Workfront API which can be used in both server (NodeJS) and client (browsers).

If used in browser environment you may need to polyfill Promises (see ES6 Promise for polyfills) and fetch (whatwg-fetch).

Usage

Server-side

Install as a dependency: npm install --save workfront-api.
Then require('workfront-api') in your code. For example:

const Workfront = require('workfront-api')

/**
 * The console.log statement below will output the following:
 * {
 *    Api: [Function: Api],
 *    ResponseHandler: { success: [Function: success], failure: [Function: failure] }
 * }
 */
console.log(Workfront)
Copy

Documentation

API documentation is available at http://workfront.github.io/workfront-api/.

Examples

A number of examples can be found under examples directory. It includes examples for both node and browser environments.
In order to run these examples clone a copy of workfront-api repository:

git clone git://github.com/Workfront/workfront-api.git
Copy

Running node examples

First enter into workfront-api directory and install all the dependencies:

cd workfront-api
yarn
Copy

Use node to run the examples. For examples:

node examples/node/get-user-count.js
Copy

Each example script outputs all its results into console and contains comments in the source code explaining what is happening in more details.

Running browser examples

To start supplied webserver type:

npm start
Copy

Visit http://localhost:8000/examples/browser/ to see list of all examples available for browser.

Contributing

We welcome contributions of all kinds from anyone. It can be either new example or fix or documentation improvement. Please read these guidelines:

Bug Reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you! Please make sure to check these points to make a good bug report:

1. Use the GitHub issue search — check if the issue has already been reported.
2. Isolate the problem — ideally create a reduced test case.
3. A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report.

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

License

Copyright (c) 2015-2019 Workfront

Licensed under the Apache License, Version 2.0. See the top-level file LICENSE and (http://www.apache.org/licenses/LICENSE-2.0).