can be used to retrieve the data you can
see on your dashboard
scripts and other means of automation.
The API is built around REST
whereby GET requests are used to retrieve data and POST, PUT,
DELETE - to modify, create and delete it
The request URL
is used to identify an item or a collection of items.
This will retrieve information on a specified license.
This will retrieve information on all licenses on file.
The request parameters
can be used to fine-tune the query.
This will retrieve infromation on first 10 licenses on file.
Errors are reported through HTTP response codes as follows:
- 400 - invalid query, malformed or missing parameters
- 401 - invalid or missing autorization token or insufficient permissions
- 404 - not found
- 429 - too many requests
- 500 - server-side error, e.g. the database is down
For successfully executed queries the response will be 200
Every API query must include an authentication token.
A token is bound to your account and assigned a set of permissions.
Some tokens can only read information (that is, be used with
GET requests), while others can have full access.
A token should be included in a query as a
HTTP Basic Auth
username. The password may be left blank.
curl https://bvckup2.com/customer/api/licenses \
Doing so will emit the following HTTP header on a wire:
Authorization: Basic YXBpX3NlY3JldF8wMDAwMTExMTIyMjI6DQo=
Alternatively, the token can be passed as a query parameter.
When retrieving collections of items, it is possible to retrieve them
in chunks by specifying the index of the first item and the maximum
The first item on a list has an index of 0.
This will retrieve up to 10 items starting with the 4th.
By default, both item and collection queries will return data
When an item can be represented as a flat list of properties,
it is also possible to request the data to be returned in
that if the result of a query is an empty list,
the CSV response will also be empty, i.e. it will not include
the header line with item's property names.