The API reference provides an overview of all methods available on the Basecone API.
In order to use the API you need a user account for Basecone and you need to register your application. If your company already has a subscription for Basecone, you can request your user account from the person who manages the Bascone environment. If no subscription exists you can request one via basecone.com, a free trial is available. Currently it is not possible to register your application yourself (we are working on that), you can request a registration by sending an email to email@example.com.
All API access is over HTTPS, and accessed from the api.basecone.com domain. All data is sent and received as JSON.
In order to maintain compatibility in the future, all requests must specify an API version, which is appended to the URL.
The current API version is v1.
The soap-based webservice is still available but will reach end-of-life in 2015. Users will be notified in a timely fashion.
The Basecone API uses Basic Authentication for authentication and authorization. More information is available on the authentication page.
HTTP VerbsThe Basecone API strives to use the appropriate verbs for each action. The following HTTP verbs are used:
|GET||Used for retrieving resources|
|POST||Used for creating resources|
|PUT||Used for updating resources|
|DELETE||Used for deleting resources|
Available HTTP verbs will be documented for each resource.
HTTP status codesThe Basecone API uses the following HTTP status codes when responding to requests:
|201||Created, used with POST requests|
|204||Updated, used with PUT requests|
|400||Bad request, request cannot be processed, learn more about specific errors here|
|404||Resource not found|
|405||Method not allowed|
|500||Internal server error, this should not happen|
UTC is used or all dates and times sent and received.