Projjex API

Overview

Each API method is represented by a unique URL, e.g. https://api.projjex.com/projects/list/. Parameters can be passed into the method in one of the following ways:

  1. Query string parameters sent on an HTTP GET request.
  2. Posted values in an HTTP POST request.

All API methods contain an optional parameter named Output that defines the format of the API response. Valid values are "XML" or "JSON", and if not specified will default to XML.

Parameter names are case insensitive.

The API supports both secure and non-secure connections. The examples in this documentation refer to the non-secure urls (http://api.projjex.com). We strongly recommend that when using the API in a production environment that you use SSL for all API calls.

Error Handling

If an error occurs in any API call, the server will respond with a single XML element named Error. The value of the element will contain the error message. If the error is due to to the user not being logged in, a Type="Login" attribute will be added to the element.

XML Sample

<Error Type="Login">
    Invalid or expired API session. Please login again.
</Error>

JSON Sample

handleProjjexData({ "Error": {"Type": "Login", "value": "Invalid or expired API session. Please login again." }});
Available Methods

The following methods are available through the Projjex™ API:

Authentication
Projects
  Items   Documents
Summary Information
Quick Links
Support

.NET developers can download our .NET API Wrapper. The wrapper simplifies using the Projjex™ API by returning .NET objects.

API Methods