Difference between revisions of "NATS5 REST API Skin PATCH colors"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Skin PATCH colors to NATS5 REST API Skin PATCH colors: Renaming NATS5 API pages) |
|
(No difference)
|
Revision as of 16:22, 9 August 2019
PATCH /skin/colors
Description
- Get color palette for skin
Resource URL
- http://domain/api/skin/colors
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- skinid
- type: digit
- required
- basic
- type: json (JSON Object)
- optional
- images
- type: json (JSON Object)
- optional
Example Request
Method: PATCH
URL: http://domain/api/skin/colors
Form Data:
- skinid: 1000
Response:
{ "success": true, "result": "Colors 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( 'skinid' => '1000', ); $request = Array( 'method' => 'PATCH', 'path' => 'v1/skin/colors', '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); ?>