The Atmos web services API is RESTful in nature and exposes functionality so that developers can programmatically create, update, delete, and modify objects stored on Atmos. Developers can also optionally add arbitrary key/value pairs to Atmos objects that trigger policies on the back-end that determines how the object is replicated, deduped, compressed, striped across nodes, etc.
There are two primary ways to consume the API: through one of the Atmos language specific bindings or by communicating with the REST API directly.
The bindings perform the heavy lifting required to build HTTP requests, sign them with a shared secret key, send the requests, and parse the responses. The bindings make the process of integrating with the Atmos API easier because the developer need not focus on the low-level HTTP communication with Atmos. Examples that illustrate how to invoke each method are contained in the unit test cases that accompany each language binding.
There are certainly cases when a developer will choose to integrate with the API directly rather than use one of the language bindings. In these cases we provide examples of each HTTP request and the corresponding signature in the Atmos Programmer's Guide. Also well documented is the specific algorithm used to generate the signature.
In either case, minimally, developers will need the following information to connect to an instance of Atmos:
- shared secret
The UID and shared secret are generated by Atmos and are provided by the administrator. Commonly, this information can be retrieved from the Atmos Cloud Delivery Platform (ACDP) portal being used with a specific Atmos instance.
The host and port refer to the specific network location of the Atmos instance that one intends to communicate with. Atmos supports, but isn't necessarily always configured with, port 443 for secure communications between the client making the requests and the server.
Atmos Online is our developer sandbox that can be used to integrate and test with the Atmos API. Get started with Atmos Online by signing up for a free developer account.