Difference between revisions of "NATS4 REST API Set Affiliate Customs"
From TMM Wiki
Jump to navigationJump to search| Line 4: | Line 4: | ||
== '''PATCH /affiliate/setcustoms''' == | == '''PATCH /affiliate/setcustoms''' == | ||
'''Description''' | '''Description''' | ||
| − | *The | + | *The affiliate/setcustoms' action is a feature in NATS4 that allows you to set an affiliates custom fields. The response contains one parameters 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''' | '''Resource URL''' | ||
Revision as of 00:50, 18 March 2015
PATCH /affiliate/setcustoms
Description
- The affiliate/setcustoms' action is a feature in NATS4 that allows you to set an affiliates custom fields. The response contains one parameters 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/v1/affiliate/setcustoms
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded
- loginid: The affiliate loginid
- type: integer
- required
- custom1: Custom field 1
- type: string
- required
- custom2: Custom field 2
- type: integer
- required
- custom3: Custom field 3
- type: integer
- required
- custom4: Custom field 4
- type: string
- required
- custom5: Custom field 5
- type: string
- required
Example Request
PATCH
http://domain/api/v1/affiliate/setcustoms
- Response:
[
{
"result": 1
}
]
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'loginid' => 2,
'custom1' => 'This',
'custom2' => 'is',
'custom3' => 'an',
'custom4' => 'API',
'custom5' => 'test'
);
$url = 'http://domain/api/affiliate/setcustoms';
$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/setcustoms'
payload = {
'loginid': 2,
'custom1': 'This',
'custom2': 'is',
'custom3': 'an',
'custom4': 'API',
'custom5': 'test'
}
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': 2,
'custom1': 'This',
'custom2': 'is',
'custom3': 'an',
'custom4': 'API',
'custom5': 'test'
}
var options = {
url: 'http://domain/api/affiliate/setcustoms',
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/setcustoms' -H "api_key: 44b5498dbcb481a0d00b404c0169af62" -H "api_username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'custom1=This&custom2=is&custom3=an&custom4=API&custom5=test&loginid=1'
