Authentication
In order to authenticate calls to our APIs, you must pass the token either:
- As the _Token parameter in the query string of a REST request, or
- In the Username value in the soap header of a SOAP request.
You can manage your
API Tokens from your account page.
Sample Code
Because they use open standards, Xignite’s APIs are easily accessible from any development environment without requiring any software installation. There are many flexible ways to integrate our APIs in your apps. The sections below provide sample code in popular programming languages you can easily copy, paste, and re-use.
Sample Code for IsHealthy
The sample code is provided "as is" without any express or implied warranty. You are solely responsible for obtaining any necessary licenses or ownership rights, including for Xignite APIs and open source code, to use this sample code. Xignite has no obligation to test, certify, or support its use.
Sample Requests
All Xignite APIs support multiple, easy-to-use, open standard protocols. You can place requests against the API using a simple REST request using POST or GET or you can place a request using SOAP. The sections below show how properly formed requests and corresponding outputs look like for each protocol.
Request
POST http://www.xignite.com/xHelp.asmx HTTP/1.1
Host: www.xignite.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.xignite.com/services/IsHealthy"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<Header xmlns="http://www.xignite.com/services/">
<Username>string</Username>
<Password>string</Password>
<Tracer>string</Tracer>
<IHeader_Username>string</IHeader_Username>
<IHeader_Password>string</IHeader_Password>
<IHeader_Tracer>string</IHeader_Tracer>
</Header>
</soap:Header>
<soap:Body>
<IsHealthy xmlns="http://www.xignite.com/services/">
<SimulateTimeout>int</SimulateTimeout>
</IsHealthy>
</soap:Body>
</soap:Envelope>
Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<IsHealthyResponse xmlns="http://www.xignite.com/services/">
<IsHealthyResult>boolean</IsHealthyResult>
</IsHealthyResponse>
</soap:Body>
</soap:Envelope>
Request
GET http://www.xignite.com/xHelp.asmx/IsHealthy?
SimulateTimeout=string HTTP/1.1
Host: www.xignite.com
Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.xignite.com/services/">boolean</boolean>
Request
POST http://www.xignite.com/xHelp.asmx/IsHealthy HTTP/1.1
Host: www.xignite.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
SimulateTimeout=string
Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.xignite.com/services/">boolean</boolean>