API Ping

GET /service/ping

Description	URL	Response Format	Request Method	Authentication
Ping the API	https://domain/api/service/ping	JSON	GET	HTTP headers

Parameters

none

Example Request

php

<?php
$url = 'http://domain/api/ping'
$curl = curl_init();

$headers = array(
    'api-key: 44b5498dbcb481a0d00b404c0169af62',
    'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
    //json was valid. Dump the decoded array
    print_r($output);
}
else {
    //invalid json, just dump the raw response
    print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

Python

This example requires pip and the request library which can be installed via pip by: 'pip install requests'

import requests

url = 'http://domain/api/ping'
headers = {
    'api-key': '44b5498dbcb481a0d00b404c0169af62',
    'api-username': 'productsupport'
}
 params =  {
        'payvia_type_id': 1,
        'rule_type': 'enabled'
 }

res = requests.get(url, params=params, headers=headers)
print res.json()

node.js

This example requires npm and the request module which can be installed via npm by: 'npm install request'

var request = require('request');

var options = {
    url: 'http://domain/api/ping',
    method: 'GET',
    json: true,
    headers: {
        'api-key': '44b5498dbcb481a0d00b404c0169af62',
        'api-username': 'productsupport'
    }
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
    else{
        console.log(body);
    }
}
request(options, callback);

curl

curl -X GET 'http://domain/api/ping' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: productsupport"

output: true