Prowork API for Developers
1. Introduction
The Prowork API allows you perform basic operations just as on the Prowork web application. The API is simple and you can use even your browser or any HTTP client in any programming language to hack it.
2. Experimental
The API is in its early stage. A lot of improvements will sure be coming to it. Changes will however be documented and announced as well. We’ve added a special change log page to help track changes. Also follow the blog and twitter account for updates.
3. Registration
Developers are required to register their apps to obtain an api_key they can use for authenticating users. Basically, the only thing we ask is the app name and description. It is available at http://prowork.me/apps
4. Base URL
The API base url for every request is available in your profile settings page
5. Result Format
The Prowork API only returns JSON encoded results. We doubt if we will be supporting any other result formats like XML in time to come.
6. Errors
Errors are returned in the JSON format:
{"error":"Error description"}
Additionaly, a non-ok HTTP header (401 and 403 mostly), will accompany the result.
Authentication tokens expire. When they do, any request to the API gives a 410 (Gone) header. You therefore have to re-authenticate the user.
7. Sample Application and Tutorial
We have the following hands-on tutorials to get you started.
8. Support
We would happily love to help with the hacking process in whatever way. For questions, API requests, error feedback and whatever, we’ve put up an API support forum. We are also interested in seeing the cool things you’ve done with the API. So be sure to share when you are done either via the twitter account @proworkapp or via hello@prowork.me