Difference between revisions of "NATS4 API"
From TMM Wiki
Jump to navigationJump to search| Line 10: | Line 10: | ||
== Authentication == | == Authentication == | ||
The NATS API uses HTTP Authentication where the username is the Affiliate username and the password is the Affiliate API key. To retrieve your API key simply select it from the login table of your NATS database or put in a support ticket and we can retrieve it for you. | The NATS API uses HTTP Authentication where the username is the Affiliate username and the password is the Affiliate API key. To retrieve your API key simply select it from the login table of your NATS database or put in a support ticket and we can retrieve it for you. | ||
| + | |||
| + | == Example == | ||
| + | The easiest way to use SOAP when using PHP is using the [http://sourceforge.net/projects/nusoap/ NuSOAP Toolkit]. Assuming you've downloaded the toolkit into a directory called nusoap, here is an example of how to connect: | ||
| + | |||
| + | <pre> | ||
| + | <? | ||
| + | require_once('nusoap/lib/nusoap.php'); | ||
| + | |||
| + | $url = 'http://nats.site.com/admin_api.php'; // change to be the domain of your NATS install | ||
| + | $username = 'NATSADMIN'; // your admin username | ||
| + | $apikey = '3385e1b470b0864e27a9b648da6c0692'; // your api key | ||
| + | |||
| + | $client = new nusoap_client($url.'?wsdl', true); | ||
| + | $client->setCredentials($username,$apikey); | ||
| + | // Check for an error | ||
| + | $err = $client->getError(); | ||
| + | if ($err) { | ||
| + | // Display the error | ||
| + | echo 'Constructor error' . $err . "\n"; | ||
| + | exit; // At this point, you know the call that follows will fail | ||
| + | |||
| + | } | ||
| + | </pre> | ||
Revision as of 13:22, 24 December 2009
The NATS Admin API is accessible at http://<domain>/admin_api.php
- Replace <domain> with your NATS install domain name.
Gaining Access to the Admin API
In order to access NATS API your IP address must be in the API_ADMIN_ALLOWED_IPS list. You can add or remove IP addresses to this list via the Configurations Admin under the "Security" tab.
Authentication
The NATS API uses HTTP Authentication where the username is the Affiliate username and the password is the Affiliate API key. To retrieve your API key simply select it from the login table of your NATS database or put in a support ticket and we can retrieve it for you.
Example
The easiest way to use SOAP when using PHP is using the NuSOAP Toolkit. Assuming you've downloaded the toolkit into a directory called nusoap, here is an example of how to connect:
<?
require_once('nusoap/lib/nusoap.php');
$url = 'http://nats.site.com/admin_api.php'; // change to be the domain of your NATS install
$username = 'NATSADMIN'; // your admin username
$apikey = '3385e1b470b0864e27a9b648da6c0692'; // your api key
$client = new nusoap_client($url.'?wsdl', true);
$client->setCredentials($username,$apikey);
// Check for an error
$err = $client->getError();
if ($err) {
// Display the error
echo 'Constructor error' . $err . "\n";
exit; // At this point, you know the call that follows will fail
}
