Informizely customer feedback surveys
By using the Aculab site, you agree with our use of cookies.

Web Services Overview

 TLS 1.0/1.1 deprecated!
 We provide wrappers in a number of high-level languages to make writing your applications easier. We recommend using these for all but the most basic testing.

Access

All web services are available for use through any HTTP client, such as cURL for the command line, or any language specific library that can perform HTTP Requests, such as Requests for python or Apache HttpClient for Java.

All services are served from the generic URL https://ws.aculabcloud.net. Each cloud region also serves all services from cloud-specific URLs of the form https://ws-[cloudID].aculabcloud.net. For example, https://ws-1-2-0.aculabcloud.net can be used for accounts in the USA-East region. The latency when using the cloud-specific URLs will be slightly lower than for the generic URL.

The service actions make up the path of the final URL. i.e. https://ws.aculabcloud.net/file_list for the File List service.

When accessing a web service using an HTTP client, the following conditions apply unless otherwise stated in the documentation for that service.

Authorisation

The format for the username and password is as follows:

Username:cloudID/username (e.g. 1-2-0/user@example.com)
Password:Your API Access Key

For example:

$ curl --user 1-2-0/user@example.com:WzyPvLMYBUMvFOgXj3S7fg https://ws.aculabcloud.net/file_list?filetype=media

Time Units

Several services return time properties. Unless otherwise documented these are specified in seconds since the Unix epoch UTC, 1st January 1970 00:00, where UTC is the Coordinated Universal Time.

Cost Units

All costs are returned in US dollars and cents.

Web Service Errors

Many of the web services will return HTTP standard response codes (e.g. 404 Not Found) if the service cannot carry out the requested action. In addition these web services may return a four digit error code that provide specific detail of the error encountered. These are described here.

TLS

TLS 1.2 and 1.3 are supported on all web services. However, for security reasons, TLS 1.0 and 1.1 are deprecated and support for these protocols will be disabled in July 2020. Those interfacing directly with these web services need to remove TLS 1.0/1.1 dependencies and disable them at the Operating System level where possible. Users of our high-level language wrappers may need to upgrade to a newer version to ensure continued operation and/or move onto a later language environment. We shall provide guidance on how to do this in due course.