XP-Dev.com Documentation

API User Guide & Documentation

This user guide only applies if your account and project is on our new platform, i.e. if your project's URL begins with https://<your-account>.xp-dev.com rather than https://xp-dev.com. If your account is on our old platform, you should be using this user guide instead.


XP-Dev.com provides a simple REST-like HTTP API for integration with your applications, tools and system. It understands JSON over HTTPS.

API Tokens

To be able to use the API, each request has to be authenticated against an API token.

To generate an API token:

  • Head to your account's Settings page
  • Click on View Account Settings in Detail

    Settings page

  • Click on Generate A New API Token

    Generate Token

The following header needs to be added to all HTTP requests when interacting with the API:

X-XPDevToken: <your token>

For e.g.:

X-XPDevToken: abcabac123456789

Marshalling Formats

XP-Dev.com's API end point only understands JSON.

When sending data to the end point, you will need to set the header field Content-Type to application/json

HTTP methods PUT and POST need the header Content-Type

End Point

All requests should begin with the base URL of your account https://<your-account>.xp-dev.com/api/v1/...

Error messages

In general, the API will return valid HTTP errors and these should be looked at the first instance. However, certain operations will have more descriptive error messages:

    message": "Permission denied"

Testing the API

Curl is the swiss army knife for testing HTTP REST-like APIs. In the following examples, it is assumed that the header X-XPDevToken has been specified to curl when making requests. For e.g.:

curl -v -H 'X-XPDevToken: abcabac123456789' https://<your-account>.xp-dev.com/api/v1/...

You should specify a marshalling format whjen sending data:

curl -v -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'X-XPDevToken: abcabac123456789' https://<your-account>.xp-dev.com/api/v1/...

Request Methods

The following request methods in general illustrate the actions being performed:

HTTP Request Method Action
GET Read
POST Create
PUT Update

Further Documentation

There are some exceptions to this rule, all detailed in the following sections:

Feel free to contact us if you need any assistance.