Difference between revisions of "NATS4 REST API Set Affiliate Information"
From TMM Wiki
Jump to navigationJump to search| Line 7: | Line 7: | ||
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api | + | *<nowiki>http://domain/api/affiliate/setinformation</nowiki> |
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| Line 93: | Line 93: | ||
'''PATCH''' | '''PATCH''' | ||
| − | <nowiki>http://domain/api | + | <nowiki>http://domain/api/affiliate/setinformation</nowiki> |
*Response: | *Response: | ||
Revision as of 15:29, 31 March 2015
PATCH /affiliate/setinformation
Description
- The /affiliate/setinformation endpoint is a feature in NATS4 that allows you to change 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/setinformation
- 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: is used to pass in the loginid of the affiliate
- type: string
- required
- firstname: is used to pass in the first name of the affiliate
- type: string
- optional
- lastname: is used to pass in the last name of the affiliate
- type: string
- optional
- email: is used to pass in the email address of the affiliate
- type: string
- optional
- company: is used to pass in the company name of the affiliate
- type: string
- optional
- url: is used to pass in the url of the affiliate
- type: string
- optional
- tel: is used to pass in the telephone number of the affiliate
- type: string
- optional
- icq: is used to pass in the icq number of the affiliate
- type: string
- optional
- aim: is used to pass in the aim name of the affiliate
- type: string
- optional
- msn: is used to pass in the msn name of the affiliate
- type: string
- optional
- address1: is used to pass in the address of the affiliate
- type: string
- optional
- address2: is used to pass in the address of the affiliate
- type: string
- optional
- city: is used to pass in the city of the affiliate
- type: string
- optional
- state: is used to pass in the state of the affiliate
- type: string
- optional
- country: is used to pass in the country of the affiliate
- type: string
- optional
- zip_code: is used to pass in the zip code of the affiliate
- type: string
- optional
- tax_id_or_ssn: is used to pass in the tax id or the ssn of the affiliate
- type: string
- optional
- mailok: is used to set the mailok field. Can either by 1 or 0.
- type: string
- optional
If you want to remove a field you can pass in the string REMOVE and the field will be removed. The following fields have this ability:
- Company
- URL
- Tel
- ICQ
- AIM
- MSN
- Address2
- tax_id_or_ssn
- mailok
Example Request
PATCH
http://domain/api/affiliate/setinformation
- Response:
[
{
"result": 1
}
]
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'loginid' => 1,
'firstname' => 'test',
'lastname' => 'test',
'email' => 'test@te,st',
'company' => 'test industries',
'tel' => '666-666-6666',
'icq' => '6666666',
'aim' => 'sixsixtysix',
'msn' => 'test',
'mailok' => '0'
);
$url = 'http://domain/api/affiliate/setinformation';
$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/setinformation'
payload = {
'loginid': 1,
'firstname': 'test',
'lastname': 'test',
'email': 'test@te,st',
'company': 'test industries',
'tel': '666-666-6666',
'icq': '6666666',
'aim': 'sixsixtysix',
'msn': 'test',
'mailok': '0'
}
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,
'firstname': 'test',
'lastname': 'test',
'email': 'test@te,st',
'company': 'test industries',
'tel': '666-666-6666',
'icq': '6666666',
'aim': 'sixsixtysix',
'msn': 'test',
'mailok': '0'
}
var options = {
url: 'http://domain/api/affiliate/setinformation',
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/setinformation' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'loginid=1&firstname=test&lastname=test&email=test%40te%2Cst&company=test+industries&url=te.st&tel=666-666-6666&icq=6666666&aim=sixsixtysix&msn=test&address1=1&mailok=0'
