Submitting to the API

All API requests to the Zaui.io platform must be sent using an HTTPS POST and must be submitted using the following URL:

https://api.zaui.io/v1/

All API access is over HTTPS and accessed from the https://api.zaui.io/v1/ domain.

$ curl -ki https://api.zaui.io/v1/
HTTP/1.1 200 OK
Date: Wed, 07 Jan 2015 00:12:51 GMT
Server: Apache
X-Powered-By: PHP/5.4.35
Vary: Accept-Encoding
Content-Length: 411
Content-Type: text/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<version xmlns="http://www.zaui.io/api" xmlns:atom="http://www.w3.org/2005/Atom" id="v1" statu
s="CURRENT" >
 <media-types>
 <media-type base="application/xml" type="application/xml;version=v1"/>
 </media-types>
 <atom:link rel="self" href="https://api.zaui.io/v1"/>
 <atom:link rel="describedby" href="http://www.zaui.io/api/v1"/>
</version>

Each response consists of an object with the following properties:

  • HTTP response status code: The status code of the HTTP response. This does match the header value of the response, unless suppress_response_codes=true was sent. For a list of valid response codes, see the appendix at the close of this document.

  • XML data payload: The result data will always return XML

Note: See Appendix A for a list of all Zaui IO HTTP Response Codes

Last updated