NATS4 REST API Get Option Rule

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

GET /option/getrule

Description

  • NATS4 supports an API resource to get option rules and their associatied info


Resource URL

  • http://domain/api/option/getrule
  • Replace domain with the nats domain

Request Method

  • GET

Response Format

  • JSON

Authentication

  • HTTP headers

Parameters

Paremeters can be sent as url encoded params.

  • optionid: The option id
    • type: integer
    • required
  • rule_type: ("SHOW", "HIDE", "ALL" or "" (empty string). "" will display both "SHOW" and "HIDE" rules.)
    • type: string
    • optional

Example Request

GET

http://domain/api/option/getrule

  • Response:
{
    "result": "TRUE",
    "params": {
        "13": {
            "option_rule_id": "13",
            "optionid": "0",
            "rule_type": "SHOW",
            "identid": "4",
            "start_time": "2006-06-06 00:00:00",
            "end_time": "2006-06-06 00:00:00",
            "cascadeid": "0",
            "override_identifier_id": "4",
            "loginid": "0",
            "networkid": "0",
            "programid": "0",
            "siteid": "0",
            "tourid": "0",
            "adtoolid": "0",
            "subid1": "0",
            "subid2": "0",
            "billerid": "0",
            "countryid": "0",
            "promotionalid": "0"
        },
        "16": {
            "option_rule_id": "16",
            "optionid": "0",
            "rule_type": "SHOW",
            "identid": "4",
            "start_time": "2014-06-12 15:27:42",
            "end_time": "0000-00-00",
            "cascadeid": "0",
            "override_identifier_id": "4",
            "loginid": "0",
            "networkid": "0",
            "programid": "0",
            "siteid": "0",
            "tourid": "0",
            "adtoolid": "0",
            "subid1": "0",
            "subid2": "0",
            "billerid": "0",
            "countryid": "0",
            "promotionalid": "0"
        },
        "23": {
            "option_rule_id": "23",
            "optionid": "0",
            "rule_type": "SHOW",
            "identid": "4",
            "start_time": "2006-06-06 00:00:00",
            "end_time": "2014-12-31 02:26:16",
            "cascadeid": "0",
            "override_identifier_id": "4",
            "loginid": "0",
            "networkid": "0",
            "programid": "0",
            "siteid": "0",
            "tourid": "0",
            "adtoolid": "0",
            "subid1": "0",
            "subid2": "0",
            "billerid": "0",
            "countryid": "0",
            "promotionalid": "0"
        }
    }
}

Example Code

PHP

<?php
$curl = curl_init();

$data = array(
    'optionid' => '1',
    'rule_type' => 'SHOW'
);

$data_string = http_build_query($data);
$url = 'http://domain/api/option/getrule?'.$data_string;

$headers = array(
    'api-key: 44b5498dbcb481a0d00b404c0169af62',
    'api-username: tmm1phrvezsbu'
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
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

url = 'http://domain/api/option/getrule'

params = {
        'optionid': 1,
        'rule_type': 'SHOW'
}

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


res = requests.get(url, params=params, 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');

var options = {
    url: 'http://domain/api/option/getrule',
    method: 'GET',
    qs: {
        'optionid': 1,
        'rule_type': 'SHOW'
    },
    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 GET 'http://domain/api/option/getrule?optionid=1&rule_type=SHOW' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu"