The Agile Bench API documentation is intended as a reference for third parties to integrate with Agile Bench. The current version is 1.
The API has been built using JSON as the payload format. We’ve attempted to make our API a native web citizen. As such it uses HTTP codes to explain status.
Users are authenticated by adding a HTTP header with a name of
AgileBench-Token1 and your personal account token. The token can be found your Account Settings.
Alternatively, you may retrieve the token using a username and password. See Token
URLs take the form:
The request HTTP header needs to include a user’s authentication token The request content type needs to be JSON, this can be specified in the HTTP Content-type header.
curl -H "AgileBench-Token: TOKEN" -H "Content-type: application/json" \ -i http://agilebench.com/api/v1/projects/PROJECT_ID
Agile Bench exposes four resources via our API. These are:
Follow the above links to get more information about each resource.
200 OK– The request has succeeded.
201 Created– The request has been fulfilled and resulted in a new resource being created
400 Bad Request– The request has attempted to access an invalid API version number. The request has attempted to perform an action which is not supported on that resource type. The request has attempted to specify a story type or estimate are not in the correct format
403 Forbidden– The request has attempted to access a resource which your TOKEN does not have the rights to.
404 File Not Found– The request is attempting to access a resource which does not exist
415 Unsupported Media Type– The request has not specified it would like JSON
500 Internal Server Error– The request has asked for to perform an action which the server cannot do. This generally is the result of a bug in Agile Bench. We track these.