REST Interface

Automated tests are able to order and pick datasets through REST.

Service Users

For any account Sixpack allows to create an unlimited number of service users. Service users can interact only with the REST interface and are considered as regular user in terms of context separation. That means that a service user cannot access datasets from other users and vice-versa.

Service users do not consume Sixpack seats below 5 times the number of real users, above that limit, 5 service users will be considered as one seat.

For example: Given you pay for 6 users, you can have up to 30 service users included. In case you have 31-35 service users, you will be charged 7 users.

Management of Service Users

Service users can be created / updated / deleted on a dedicated page.

Each service user may have a freely chosen handle. The handle is just for information and the platform does not require it to be unique.

Sixpack assigns to each user an ID and an API Key. The User ID and API Key are used to authenticate the user against the REST interface.

Upon request, the API Key is regenerated with immediate effect.

Authentication

Service users authenticate with the REST API with a HMAC signature header. This involves a simple algorithm that needs to be implemented by the REST client. Examples how to implement that are given in the reference documentation here.

Getting datasets in two phases

To get a dataset, a request needs to be filed first. The response contains the dataset ID.

A second request can be then sent to get a fresh status of the dataset anytime. The response contains the dataset itself. A parameter allows to make the server wait until the dataset is fulfilled (generated) before replying. There is no hard limit for this long poll, but we only guarantee 30s.