Offerit API - Revision history

OfferitDave at 01:09, 29 January 2014

2014-01-29T01:09:36Z

OfferitJames: /* Authentication */

2013-03-01T14:33:18Z

‎Authentication

OfferitJames: /* Authentication */

2013-03-01T14:32:28Z

‎Authentication

OfferitRobC at 22:50, 23 December 2011

2011-12-23T22:50:45Z

74.0.199.110 at 17:54, 12 December 2011

2011-12-12T17:54:35Z

75.99.182.234 at 21:08, 25 October 2011

2011-10-25T21:08:01Z

OfferitJames at 17:50, 19 October 2011

2011-10-19T17:50:33Z

OfferitJames: Created page with "{{Offerit Manual | show_api_admin_section = true }} The Offerit API is accessible at http:///admin_api.php *Replace with your NATS install domain name. == Gaini..."

2011-10-19T17:50:08Z

Created page with "{{Offerit Manual | show_api_admin_section = true }} The Offerit API is accessible at http://<domain>/admin_api.php *Replace <domain> with your NATS install domain name. == Gaini..."

New page

{{Offerit Manual
| show_api_admin_section = true
}}
The Offerit 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 Offerit API, your IP address must be in the ADMIN_API_ALLOWED_IPS list. You can add or remove IP addresses to this list via the Configurations Admin under the "Security" tab.

If you're also using ADMIN_IPS to restrict access to your admin, you must also add the IP to that list, as this is also an admin page.

== Authentication ==
The Offerit 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 Offerit 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 = 'OFFERITADMIN'; // your admin username
$apikey = 'afsb35gh8j3rgasfdgja9r8ebja59gb8'; // 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>

To give a complete example of this, here's an example using the [[NATS4_API_Ping|ping]] function. This is how to call it:
<pre>
<?
require_once('nusoap/lib/nusoap.php');

$url = 'http://offerit.site.com/admin_api.php'; // change to be the domain of your NATS install
$username = 'offeritadmin'; // your admin username
$apikey = 'afsb35gh8j3rgasfdgja9r8ebja59gb8'; // 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

}
$result = $client->call('ping', Array(), 'natsapiadmin_wsdl');
var_dump($result);
</pre>

And this is the output:
<pre>
bool(true)
</pre>

[[Category:Offerit API Articles]]

@@ Line 13: / Line 13: @@
 The Offerit API uses HTTP Authentication where the username is the Affiliate username and the password is the Affiliate API key.
-'''Note:''' ''Affiliates do not start with an API key and you will have to manually create one for each affiliate that wants access to the API.  In addition, API access is only available to admin-level Offerit users.''
+'''Note:''' ''Affiliates do not start with an API key and you will have to manually create one for each affiliate that wants access to the API.  In addition, API access is only available to admin-level affiliates.''
 To retrieve an API key for an affiliate, go to the Affiliates admin and click "View/Change API Key".  On the next page, you can create an API key for the user you clicked on by clicking "Generate API Key".

← Older revision		Revision as of 22:50, 23 December 2011
Line 64:		Line 64:
	bool(true)		bool(true)
	</pre>		</pre>
−
−	~~[[Category:Offerit API Articles]]~~

@@ Line 60: / Line 60: @@
+}
-$result = $client->call('ping', Array(), 'natsapiadmin_wsdl');
+$result = $client->call('ping', Array(), 'offeritapiadmin_wsdl');
 var_dump($result);
 </pre>

@@ Line 11: / Line 11: @@
 == Authentication ==
-The Offerit 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 Offerit database or put in a support ticket and we can retrieve it for you.
+The Offerit API uses HTTP Authentication where the username is the Affiliate username and the password is the Affiliate API key.
 == Example ==

@@ Line 42: / Line 42: @@
 require_once('nusoap/lib/nusoap.php');
-$url = 'http://offerit.site.com/admin_api.php'; // change to be the domain of your NATS install
+$url = 'http://offerit.site.com/admin_api.php'; // change to be the domain of your Offerit install
 $username = 'offeritadmin'; // your admin username
 $apikey = 'afsb35gh8j3rgasfdgja9r8ebja59gb8'; // your api key

@@ Line 20: / Line 20: @@
 require_once('nusoap/lib/nusoap.php');
-$url = 'http://nats.site.com/admin_api.php'; // change to be the domain of your NATS install
+$url = 'http://offerit.site.com/admin_api.php'; // change to be the domain of your Offerit install
 $username = 'OFFERITADMIN'; // your admin username
 $apikey = 'afsb35gh8j3rgasfdgja9r8ebja59gb8'; // your api key
@@ Line 37: / Line 37: @@
-To give a complete example of this, here's an example using the [[NATS4_API_Ping|ping]] function. This is how to call it:
+To give a complete example of this, here's an example using the [[Offerit_API_Ping|Ping]] function. This is how to call it:
 <pre>
 <?

@@ Line 3: / Line 3: @@
 }}
 The Offerit API is accessible at http://<domain>/admin_api.php
-*Replace <domain> with your NATS install domain name.
+*Replace <domain> with your Offerit install domain name.
 == Gaining Access to the Admin API ==