Jabwire API

The Jabwire API allows the user to make RESTful calls to interact with the system. These calls can be used to:

• Write desktop client
• Create a iPhone application
• Integrate content from a third-party

Authentication

The Jabwire API allows two forms of authentication:

• HTTP Basic Authentication using your username and password
• Parameters using an API key

Both methods provide the same access to the APIs. The only difference is the way the client is authenticated.

Hostname

All API calls must be made to https://jabwire.com.

HTTP Basic Authentication

HTTP Basic Authentication is an easy way to get started accessing the Jabwire APIs. Simply provide your username and password as the credentials for the authentication and you can start accessing the API.

Example:

curl -u dshimy:password https://jabwire.com/projects.json

Parameters via API Key

The HTTP Basic Authentication will work well for most use cases. However, if you need to supply credntials to a third party for access, some people are not confortable providing their plain-text password. For these cases, we allow users to use an API key to access the system.

You can view your API key under the Settings / API Key.

Example:

curl https://jabwire.com/projects.json?api=xxxxxxxxxxxxxxxxx

Error Handling

The system will return somewhat meaningful error messages if a request cannot be processed. The client needs to be able to respond accordingly when an error is encountered.

Example:

{
  "error": "Authentication is required, see http://www.jabwire.com/support"
}