ping()

Ping – this is a way to check if API key is active and if there is a response from the server. If problems are detected, the server returns a notification.

ping() : string

Information obtained

• Message “Everything is ok!” in case everything works. Otherwise, an error message is returned.

Examples

mgapi_ping.php

ping();
 
header("Content-Type: text/plain");
if ($api->errorCode) {
    echo "Unable to ping!\n";
    echo "\tCode=" . $api->errorCode . "\n";
    echo "\tMsg=" . $api->errorMessage . "\n";
} else {
    echo "Returned: " . $retval . "\n";
}

xml-rpc_ping.php

 new xmlrpcval($apikey)
                ),
                'struct');
$f = new xmlrpcmsg('ping', array($v));
$c = new xmlrpc_client($apiUrl["path"], $apiUrl['host'], 80);
$c->setDebug($debug);
$r = &$c->send($f);
 
header("Content-Type: text/plain");
if (!$r->faultCode()) {
    $retval = php_xmlrpc_decode($r->value());
    echo "Returned: " . $retval . "\n";
} else {
    echo "Unable to ping!\n";
    echo "\tCode=" . $r->faultCode() . "\n";
    echo "\tMsg=" . $r->faultString() . "\n";
}

mgapi_ping.py

from lib.config import * #contains apikey
from lib.MGAPI import MGAPI
 
# This Example shows how to ping using the MGAPI.php class and do some basic error checking.
 
api = MGAPI(apikey)
 
retval = api.ping()
if api.errorCode:
    print "Unable to ping!"
    print "\tCode=", api.errorCode
    print "\tMsg=", api.errorMessage
else:
    print "Returned: ", retval