Difference between revisions of "NATS5 REST API Config PATCH section"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''PATCH /config/section''' == '''Description''' * Update a config section '''Resource URL''' *<nowiki>http://domain/api...") |
|||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_config_section = true |
}} | }} | ||
== '''PATCH /config/section''' == | == '''PATCH /config/section''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Update a config section | * Update a config section | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*PATCH | *PATCH | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 28: | Line 29: | ||
** required | ** required | ||
| − | [[Category: | + | == '''Example Request''' == |
| − | [[Category: | + | Method: '''PATCH'''<br/> |
| + | URL: <nowiki>http://domain/api/config/section</nowiki><br/> | ||
| + | Form Data:<br/> | ||
| + | * section: affiliates | ||
| + | * settings: [{"key":"RESELLER_VERIFY","value":"1"},{"key":"RESELLER_MANUAL_ACTIVATION","value":0},{"key":"CLOSED_AFFILIATE_SIGNUP","value":""},{"key":"ACCOUNT_REP_NATSCODE","value":0},{"key":"ACCOUNT_REP_NATSCODE_AS_REF","value":0},{"key":"ASSIGN_RANDOM_ACCOUNT_REPS","value":0},{"key":"AFFILIATE_NON_UNIQUE_EMAILS","value":""},{"key":"DISABLE_REFERRAL_USERNAME_DISPLAY","value":0},{"key":"AFFILIATE_SIGNUP_CAPTCHA","value":0},{"key":"GOOGLE_RECAPTCHA","value":""},{"key":"GOOGLE_RECAPTCHA_KEY","value":""},{"key":"GOOGLE_RECAPTCHA_SECRET","value":""}] | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "result": "Config Settings updated" | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | == '''Example Code''' == | ||
| + | |||
| + | '''PHP''' | ||
| + | <pre> | ||
| + | <?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( | ||
| + | 'section' => 'affiliates', | ||
| + | 'settings' => json_encode(array ( 0 => array ( 'key' => 'RESELLER_VERIFY', 'value' => '1', ), 1 => array ( 'key' => 'RESELLER_MANUAL_ACTIVATION', 'value' => 0, ), 2 => array ( 'key' => 'CLOSED_AFFILIATE_SIGNUP', 'value' => '', ), 3 => array ( 'key' => 'ACCOUNT_REP_NATSCODE', 'value' => 0, ), 4 => array ( 'key' => 'ACCOUNT_REP_NATSCODE_AS_REF', 'value' => 0, ), 5 => array ( 'key' => 'ASSIGN_RANDOM_ACCOUNT_REPS', 'value' => 0, ), 6 => array ( 'key' => 'AFFILIATE_NON_UNIQUE_EMAILS', 'value' => '', ), 7 => array ( 'key' => 'DISABLE_REFERRAL_USERNAME_DISPLAY', 'value' => 0, ), 8 => array ( 'key' => 'AFFILIATE_SIGNUP_CAPTCHA', 'value' => 0, ), 9 => array ( 'key' => 'GOOGLE_RECAPTCHA', 'value' => '', ), 10 => array ( 'key' => 'GOOGLE_RECAPTCHA_KEY', 'value' => '', ), 11 => array ( 'key' => 'GOOGLE_RECAPTCHA_SECRET', 'value' => '', ),)), | ||
| + | ); | ||
| + | |||
| + | $request = Array( | ||
| + | 'method' => 'PATCH', | ||
| + | 'path' => 'v1/config/section', | ||
| + | '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); | ||
| + | ?> | ||
| + | </pre> | ||
| + | |||
| + | [[Category:NATS5_REST_APIs]] | ||
| + | [[Category:NATS5_REST_config_Collection]] | ||
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
| + | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Latest revision as of 15:59, 9 August 2019
PATCH /config/section
Description
- Update a config section
Resource URL
- http://domain/api/config/section
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- section
- type: string
- required
- settings
- type: json (JSON Object)
- required
Example Request
Method: PATCH
URL: http://domain/api/config/section
Form Data:
- section: affiliates
- settings: [{"key":"RESELLER_VERIFY","value":"1"},{"key":"RESELLER_MANUAL_ACTIVATION","value":0},{"key":"CLOSED_AFFILIATE_SIGNUP","value":""},{"key":"ACCOUNT_REP_NATSCODE","value":0},{"key":"ACCOUNT_REP_NATSCODE_AS_REF","value":0},{"key":"ASSIGN_RANDOM_ACCOUNT_REPS","value":0},{"key":"AFFILIATE_NON_UNIQUE_EMAILS","value":""},{"key":"DISABLE_REFERRAL_USERNAME_DISPLAY","value":0},{"key":"AFFILIATE_SIGNUP_CAPTCHA","value":0},{"key":"GOOGLE_RECAPTCHA","value":""},{"key":"GOOGLE_RECAPTCHA_KEY","value":""},{"key":"GOOGLE_RECAPTCHA_SECRET","value":""}]
Response:
{
"success": true,
"result": "Config Settings 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(
'section' => 'affiliates',
'settings' => json_encode(array ( 0 => array ( 'key' => 'RESELLER_VERIFY', 'value' => '1', ), 1 => array ( 'key' => 'RESELLER_MANUAL_ACTIVATION', 'value' => 0, ), 2 => array ( 'key' => 'CLOSED_AFFILIATE_SIGNUP', 'value' => '', ), 3 => array ( 'key' => 'ACCOUNT_REP_NATSCODE', 'value' => 0, ), 4 => array ( 'key' => 'ACCOUNT_REP_NATSCODE_AS_REF', 'value' => 0, ), 5 => array ( 'key' => 'ASSIGN_RANDOM_ACCOUNT_REPS', 'value' => 0, ), 6 => array ( 'key' => 'AFFILIATE_NON_UNIQUE_EMAILS', 'value' => '', ), 7 => array ( 'key' => 'DISABLE_REFERRAL_USERNAME_DISPLAY', 'value' => 0, ), 8 => array ( 'key' => 'AFFILIATE_SIGNUP_CAPTCHA', 'value' => 0, ), 9 => array ( 'key' => 'GOOGLE_RECAPTCHA', 'value' => '', ), 10 => array ( 'key' => 'GOOGLE_RECAPTCHA_KEY', 'value' => '', ), 11 => array ( 'key' => 'GOOGLE_RECAPTCHA_SECRET', 'value' => '', ),)),
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/config/section',
'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);
?>
