API Implementation Guide

<?php
/*
 * The key can be provided in several ways for authentication
 *
 * The simplest way is to authenticate as the NodeWorx or SiteWorx user
 * you wish to execute as.
 */
$key = array( 'email'    => 'nodeworxlogin@example.com',
              'password' => 'nodeworxpass' );
/* OR */
$key = array( 'email'    => 'siteworx@siteworx.com',
              'password' => 'siteworxpass',
              'domain'   => 'example.com' );

/*
 * Alternately, you can provide an active SESSION_ID
 *
 * You can retrieve the session id by using an alternate authentication
 * method and then calling the getSession action on the NodeWorx or
 * SiteWorx Index controllers.
 */
$key = array( 'sessionid' => '3c8ae9d982edd507428d8fdd53855a77' );

/*
 * Finally, if you have access to an API key, you can provide that.
 *
 * Copy and paste the entire contents of the API Key field in NodeWorx.
 */
$key =
'-----BEGIN INTERWORX API KEY-----
...
-----END INTERWORX API KEY-----';              

/*
 * The example below shows you how to use the API to add a secondary
 * nodeworx user.
 */

$api_controller = '/nodeworx/users';
$action         = 'add';

// Be aware that even actions that require no input still require the parameter
// Just pass in an empty array
$input = array( 'nickname'         => 'Example User',
                'email'            => 'exampleuser@example.com',
                'language'         => 'en-us',
                'theme'            => 'interworx',
                'password'         => 'pass',
                'confirm_password' => 'pass',
                'perms'            => array( 'LOGIN', 'SWACCOUNTS' ) );

$params = array( 'apikey'    => $key,
                 'ctrl_name' => $api_controller,
                 'action'    => $action,
                 'input'     => $input );

// You can connect using XMLRPC, like this:
// NOTE: You'll need to have included the Zend Framework to do this
$client = new Zend_XmlRpc_Client( 'https://%%SERVERNAME%%:2443/nodeworx/xmlrpc-api' );
$result = $client->call( 'iworx.route', $params );

// Or, you can use SOAP, like this:
// NOTE: if SOAP is missing, try 'yum install php-soap'
$client = new SoapClient( 'https://%%SERVERNAME%%:2443/nodeworx/soap?wsdl' );
$result = $client->route( $key, $api_controller, $action, $input );
?>

array( 'status'  => 0, // 0 means success, everything else doesn't
       'payload' => 'message or data' );