Offerit API Add Affiliate Sale

2011-12-12T21:17:09Z

74.0.199.110:

{{Offerit Manual
| show_api_admin_section = true
}}
This function allows you to add a sale for a specific affiliate. To use this function, you must make a SOAP call with the following parameters:

* '''orderid''' - Your unique orderid that will be associated with the OfferIt customer record
* '''amount''' - The amount spent on the offer by the customer (optional)
* '''offeritcode''' - This can be either the encoded, un-encoded, or shortname version of the OfferIt Code. You can take this code out of the URL during a conversion and just pass it along. This will tell Offerit which offer, landing page, payout, and affiliate this traffic is for. (Explained in more detail below)
* '''customer''' - OPTIONAL: The name of the array used to pass in customer data with the following elements:
** '''username''' - The customer's User Name
** '''password''' - The customer's Password
** '''firstname''' - The customer's First name
** '''lastname''' - The customer's Last name
** '''address1''' - The customer's Address
** '''address2''' - The customer's Address 2
** '''zip''' - The customer's Zip Code
** '''city''' - The customer's City
** '''country''' - The customer's Country
** '''state''' - The customer's State
** '''shipping_firstname''' - The customer's Shipping First name
** '''shipping_lastname''' - The customer's Shipping Last name
** '''shipping_address1''' - The customer's Shipping Address
** '''shipping_address2''' - The customer's Shipping Address 2
** '''shipping_zip''' - The customer's Shipping Zip Code
** '''shipping_city''' - The customer's Shipping City
** '''shipping_country''' - The customer's Shipping Country
** '''shipping_state''' - The customer's Shipping State
** '''phone''' - The customer's Phone Number
** '''email''' - The customer's Email Address
** '''mailok''' - Can OfferIt send the customer an Email?
** '''custom1''' - Store custom data about the customer
** '''custom2''' - Store custom data about the customer
** '''custom3''' - Store custom data about the customer
** '''custom4''' - Store custom data about the customer
** '''custom5''' - Store custom data about the customer
* '''currency''' - OPTIONAL: The three-letter abbreviation of the currency type
* '''time''' - OPTIONAL: The time the sale occurred as a unix timestamp or mysql date format

== NuSOAP Example ==

This example continues from the [[Offerit_API#Example|main article NuSOAP Example]]:

<pre>
$values = Array(
'orderid'=>'ABCDEFGHI',
'amount'=>1,
'offeritcode'=>'Mi4yLjEuMS4wLjAuMC4wLjAuMC4wLjA',
'customer'=>Array(
'firstname'=>'Ben',
'lastname'=>'Warren'
)
);

$result = $client->call('set_aff_sales_add', $values, 'offeritapiadmin_wsdl');
</pre>

=== Sample Output ===

<pre>
On success:
array(3) {
["message"]=>string(11) "Add Success"
["customerid"]=>int(124)
["orderid"]=>string(9) "ABCDEFGHI"
}

On error:
error message
</pre>

==Server Request/Response==
'''Request:'''
<pre>
<?xml version="1.0" encoding="ISO-8859-1"?><SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:tns="urn:offeritapiadmin_wsdl"><SOAP-ENV:Body><tns:set_aff_sales_add xmlns:tns="urn:offeritapiadmin_wsdl">
<orderid xsi:type="xsd:string">ABCDEFGHI</orderid>
<amount xsi:type="xsd:string">1</amount>
<offeritcode xsi:type="xsd:string">Mi4yLjEuMS4wLjAuMC4wLjAuMC4wLjA</offeritcode>
<customer xsi:type="tns:Member">
<firstname xsi:type="xsd:string">Ben</firstname>
<lastname xsi:type="xsd:string">OfferIt</lastname>
<currency xsi:type="xsd:string">USD</currency>
<time xsi:type="xsd:string">1319475600</time>
</tns:set_aff_sales_add></SOAP-ENV:Body></SOAP-ENV:Envelope>
</pre>

'''Response:'''
<pre>
<?xml version="1.0" encoding="ISO-8859-1"?><SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body><ns1:set_aff_sales_addResponse xmlns:ns1="urn:offeritapiadmin_wsdl">
<message xsi:type="xsd:string">Add Success</message><customerid xsi:type="xsd:int">124</customerid><orderid xsi:type="xsd:string">ABCDEFGHI</orderid>
</ns1:set_aff_sales_addResponse></SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</pre>

[[Category:Offerit API Articles]]

Offerit API

2011-12-12T17:54:35Z

74.0.199.110:

{{Offerit Manual
| show_api_admin_section = true
}}
The Offerit API is accessible at http://<domain>/admin_api.php
*Replace <domain> with your Offerit 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://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

$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 [[Offerit_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 Offerit 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]]

Offerit - User contributions [en]

Offerit API Add Affiliate Sale

Offerit API