NATS5 REST API Affiliate PATCH payvia-info
From TMM Wiki
Jump to navigationJump to search
PATCH /affiliate/payvia-info
Note: This is an autogenerated wiki page for the NATS5 API. There may be additional descriptions or examples available on the NATS 4 API wiki for this API.
Description
- Update payvia info for a specific affiliate
Resource URL
- http://domain/api/affiliate/payvia-info
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- loginid
- type: digit
- required
- payvia_type_id
- type: digit
- required
- minimum_payout
- type: digit
- required
- payvia_info
- type: json (JSON Object)
- required
Example Request
Method: PATCH
URL: http://domain/api/affiliate/payvia-info
Form Data:
- loginid: 3
- payvia_type_id: 1
- payvia_info: [{"payvia_field_id":"1","value":"me"},{"payvia_field_id":"30","value":"test st"},{"payvia_field_id":"31","value":""},{"payvia_field_id":"32","value":"city"},{"payvia_field_id":"33","value":"state"},{"payvia_field_id":"34","value":"11111"},{"payvia_field_id":"35","value":"United States"}]
- minimum_payout: 100
Response:
{
"success": true,
"result": "Payvia information updated"
}
Example Code
PHP
<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'http://yourdomain.com'; //set your NATS URL here
$data = Array(
'loginid' => '3',
'payvia_type_id' => 1,
'payvia_info' => json_encode(array ( 0 => array ( 'payvia_field_id' => '1', 'value' => 'me', ), 1 => array ( 'payvia_field_id' => '30', 'value' => 'test st', ), 2 => array ( 'payvia_field_id' => '31', 'value' => '', ), 3 => array ( 'payvia_field_id' => '32', 'value' => 'city', ), 4 => array ( 'payvia_field_id' => '33', 'value' => 'state', ), 5 => array ( 'payvia_field_id' => '34', 'value' => '11111', ), 6 => array ( 'payvia_field_id' => '35', 'value' => 'United States', ),)),
'minimum_payout' => 100,
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/affiliate/payvia-info',
'data' => $data
);
/*code below is the same for (almost) every API call */
$curl = curl_init();
$url = $url.'/api/'.$request['path'];
$query = http_build_query($request['data']);
if($request['method'] == 'GET'){
//add query string parameters to the end of the url
$url = $url.'?'.$query;
}else{
//send parameters as POST fields
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $query);
if($request['method'] != 'POST'){
$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$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);
?>
