NATS4 API Get Affiliate Campaigns

From TMMwiki
Jump to: navigation, search
NATS 4
SOAP API
API
WSDL Cache
Add Affiliate
Add Member Note
Admin Get Adtools
Adtool Categories
Adtool Types
Affiliate Get Campaigns
Bulk Import Adtools
Caching
Decode Natscode
Expire Manual Member
Get Affiliate Campaigns
Get Affiliate Hit Data
Get Affiliate Loginids
Get Affiliate Nats Codes
Get Affiliate Payout
Get Affiliate Program Campaign List
Get_Affiliate_Program_Campaign_List
Get Member Details
Get Member Instant Upgrade String
Get Member Package Upgrade String
Get Member Token Rebuy String
Get Member Upsell String
Get Payment Data
Get Payvia Rule
Get Profit Loss Report
Ping
Record Member Login
Search Affiliate Info
Search Member Info
Send Email API Function
Set Affiliate Admin Settings
Set Affiliate Customs
Set Affiliate Defaults
Set Affiliate Information
Set Affiliate Settings
Set Member Details
Set Payment Status
Set Payvia Rule
REST API
API Overview
REST API PATH UPDATES
GET /adtools/types
GET /adtools/categories
GET /adtools/admin
POST /adtools/importdump
GET /affiliate/hitdata
GET /affiliate/campaigns
GET /affiliate/payout
GET /affiliate/searchinfo
POST /affiliate/addaffiliate
POST /affiliate/invoice
PATCH /affiliate/setcustoms
PATCH /affiliate/setinformation
PATCH /affiliate/setadminsettings
PATCH /affiliate/setpayviainfo
PATCH /affiliate/setdefaults
PATCH /affiliate/setsettings
GET /decodenatscode
GET /member/upsellstring
GET /member/tokenrebuystring
GET /member/instantupgradestring
GET /member/packageupgradestring
GET /member/details
GET /member/cancelstring
GET /member/signupplusstring
GET /member/searchinfo
POST /member/addnote
POST /member/recordlogin
PUT /member/expiremanual
PATCH /member/setdetails
PATCH /member/setexpiration
GET /option/getrule
POST /option/addrule
PUT /option/edittext
PATCH /option/editrule
GET /payments/getpayments
PATCH /payments/setstatus
GET /payviarule
PATCH /payviarule
GET /ping
GET /profitlossreport
POST /sendemail
GET /suggestedcanceloffers

NATS4 supports an API function to get the affiliate's campaigns.

get_affiliate_campaigns accepts the following parameters:

  • userid - The affiliate ID. This parameter is required.
  • orderby - The ordering of the returned campaigns. This parameter is optional and is defaulted to the campaign name. You can order by the following fields: campaignid, name, description and created_date. You can choose asc or desc for ascending or descending ordering.

NuSOAP Example

This example continues from the main article NuSOAP Example):

$params = Array(
	'userid' => '2',
	'orderby' => 'name desc',
);

$result = $client->call('get_affiliate_campaigns', $params, 'natsapiadmin_wsdl');

print_r($result);

Affiliate Campaign Data Output

The output will be the campaign ID with the campaign name.

Array
(
    [0] => Array
        (
            [campaignid] => 0
            [name] => Default
        )
    [1] => Array
        (
            [campaignid] => 4
            [name] => testings001
        )

    [2] => Array
        (
            [campaignid] => 1
            [name] => TEMP
        )

    [3] => Array
        (
            [campaignid] => 2
            [name] => New
        )
)