API Usage

Accessing the API

Access to the API requires an account enabled for API access and an application key (VKey) for your application created. You will also need to provide the IP addresses of your development and test environments for us to permit API access. To access the API, you'll need to generate a VKey by using the Applications section of your account.

Understanding API Requests

The API uses XML to communicate requests to and from the server. The XML should be sent as POST data directly to the API URL. Multiple API requests can be sent for each POST in order to apply a full configuration in one transaction.

Sending API Request

API requests can be sent using your programming language of choice on any platform, provided that the computer sending the requests has had it's IP address permitted for access (see 'Accessing the API' above). All API requests should be POSTed to the following URL;

  https://xml.ttnc.co.uk

Formatting of API Requests

The XML document should always start with the opening tag NoveroRequest and finish by closing it; /NoveroRequest. Inside of these tags, multiple API requests can be queued using the Request tag. The requests are processed in the order they are placed in the XML. The Request tag should have 3 attributes attached; name, target and id. The name and the target are references to the type of request you wish to perform and the id, while not required, is used to 'tag' the request for easy retrieval from the response.

  <?xml version="1.0"?>
  <NoveroRequest>
      <Request target="..." name="..." id="Request1">

          /* First API Request */

      </Request>
      <Request target="..." name="..." id="Request2">

          /* Second API Request */

      </Request>
  </NoveroRequest>

Understanding API Responses

Upon the API receive one of more Request calls, a response will be given to each in the order they were received. If the Request was tagged with an id, the same id will be an attribute on the Response; so you can easily identify which Response relates to which Request. In addition to the id, each Response also includes a code attribute. This is the return code of the Response, a 200 code indicates a successful request, anything else is a failure and the response will include reasons for the failure.

  <?xml version="1.0"?>
  <NoveroResponse>
      <Response target="..." name="..." Code="200" RequestId="Request1">

          /* Response XML */

      </Response>
      <Response target="..." name="..." Code="200" RequestId="Request2">

          /* Response XML */

      </Response>
  </NoveroResponse>

Help Centre