NATS4 REST API Set Affiliate Admin Settings

From TMM Wiki
Jump to navigationJump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
NATS 4
Members Admin
The Members Admin
View Member Details
Add Member
MySQL Auth
Mod Authn DB
Multisite Access
Member Logging
Member Password Retrieval
OpenID Connect
Mod Auth OpenIDC
ID Numbers
SOAP API
API
API Best Practices
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
API Best Practices
REST API PATH UPDATES
Adtools
GET /adtools/admin
GET /adtools/categories
GET /adtools/types
POST /adtools/importdump
Affiliate
GET /affiliate/campaigns
GET /affiliate/hitdata
GET /affiliate/payout
GET /affiliate/searchinfo
POST /affiliate/addaffiliate
POST /affiliate/invoice
PATCH /affiliate/setadminsettings
PATCH /affiliate/setcustoms
PATCH /affiliate/setdefaults
PATCH /affiliate/setinformation
PATCH /affiliate/setpayviainfo
PATCH /affiliate/setsettings
PATCH /affiliate/status
Member
GET /member/authstring
GET /member/details
GET /member/searchinfo
GET /suggestedcanceloffers
PATCH /member/setdetails
PATCH /member/setexpiration
POST /member/addnote
POST /member/recordlogin
PUT /member/expiremanual
PATCH /member/forget
Option
GET /option/options
GET /option/rule
PATCH /option/rule
PATCH/option/text
POST /option/rule
Payments
GET /payments/getpayments
GET /payviarule
PATCH /payments/setstatus
PATCH /payviarule
Report
GET /profitlossreport
Get /transactionpayouts
GET /report/transaction
Service
GET /service/decodenatscode
GET /service/ping
POST /service/sendemail

PATCH /affiliate/setadminsettings

Description

  • The /affiliate/setadminsettings action is a feature in NATS4 that allows you to change admin settings for your affiliates outside of the NATS system. The response contains one parameter named result. If the modification was successful then result will be 1. If it was not successful then the result will be 0.

Resource URL

  • http://domain/api/affiliate/setadminsettings
  • Replace domain with the nats domain

Request Method

  • PATCH

Response Format

  • JSON

Authentication

  • HTTP headers

Parameters

Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded

NOTE: The values for the fields are 0 for off or 1 for on.

  • loginid: is the affiliates loginid
    • type: string
    • required
  • select1: is the select1 value
    • type: string
    • optional
  • select2: is the select2 value
    • type: string
    • optional
  • select3: is the select3 value
    • type: string
    • optional
  • select4: is the select4 value
    • type: string
    • optional
  • select5: is the select5 value
    • type: string
    • optional
  • flag1: is the flag1 value
    • type: string
    • optional
  • flag2: is the flag2 value
    • type: string
    • optional
  • flag3: is the flag3 value
    • type: string
    • optional
  • flag4: is the flag4 value
    • type: string
    • optional
  • flag5: is the flag5 value
    • type: string
    • optional
  • reviewed: is the reviewed value
    • type: string
    • optional
  • invoicer: is the invoicer value
    • type: string
    • optional
  • req_docs: is the req_docs value
    • type: string
    • optional
  • w9: is the w9 value
    • type: string
    • optional
  • trust_level: is the trust_level value
    • type: string
    • optional

Example Request

PATCH

http://domain/api/affiliate/setadminsettings

  • Response:
[
    {
        "result": 1
    }
]

Example Code

PHP

<?php
$curl = curl_init();

$data = array(
    'loginid' => 1,
    'w9' => '1',
    'reviewed' => '1'
);

$url = 'http://domain/api/affiliate/setadminsettings';

$headers = array(
    'api-key: 44b5498dbcb481a0d00b404c0169af62',
    'api-username: tmm1phrvezsbu'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>

Python

  • This example requires pip and the request library which can be installed via pip by: 'pip install requests'
import requests
import json

url = 'http://domain/api/affiliate/setadminsettings'

payload = {
    'loginid': 1,
    'w9': '1',
    'reviewed': '1'
}


headers = {
        'api-key': '44b5498dbcb481a0d00b404c0169af62',
        'api-username': 'tmm1phrvezsbu'
        }

res = requests.patch(url, data=payload, headers=headers)
print res.json()


node.js

  • This example requires npm and the request module which can be installed via npm by: 'npm install request'
var request = require('request');

data = {
    'loginid': 1,
    'w9': '1',
    'reviewed': '1'
}

var options = {
    url: 'http://domain/api/affiliate/setadminsettings',
    method: 'PATCH',
    form: data,
    json: true,
    headers: {
        'api-key': '44b5498dbcb481a0d00b404c0169af62',
        'api-username': 'tmm1phrvezsbu'
    }
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
    else{
        console.log(body);
    }

}

request(options, callback);

Curl

curl -X PATCH 'http://domain/api/affiliate/setadminsettings' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'loginid=1&w9=1&reviewed=1'