Difference between revisions of "NATS5 REST API Adtool POST type"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Adtool POST type to NATS5 REST API Adtool POST type: Renaming NATS5 API pages) |
|||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{NATS5 Manual |
− | | | + | | show_api_admin_adtool_section = true |
}} | }} | ||
== '''POST /adtool/type''' == | == '''POST /adtool/type''' == | ||
+ | |||
'''Description''' | '''Description''' | ||
* Add new adtool type | * Add new adtool type | ||
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''']] |
*POST | *POST | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
− | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
Line 123: | Line 124: | ||
</pre> | </pre> | ||
− | [[Category: | + | [[Category:NATS5_REST_APIs]] |
− | [[Category: | + | [[Category:NATS5_REST_adtool_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 --> | [[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 16:57, 9 August 2019
POST /adtool/type
Description
- Add new adtool type
Resource URL
- http://domain/api/adtool/type
- Replace domain with the nats domain
- POST
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- name
- type: string
- required
- adtool_category_id
- type: digit
- optional (default value: 4)
- copy_adtool_type_id
- type: digit
- optional
- description
- type: string
- optional
- disp_tpl
- type: string
- optional
- form_tpl
- type: string
- optional
Example Request
Method: POST
URL: http://domain/api/adtool/type
Form Data:
- name: testType
- adtool_category_id: 2
- copy_adtool_type_id: 2
- description: test type addition
- disp_tpl: page
- form_tpl: fhg
Response:
{ "success": true, "result": "adtool type added", "type": false }
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( 'name' => 'testType', 'adtool_category_id' => 2, 'copy_adtool_type_id' => 2, 'description' => 'test type addition', 'disp_tpl' => 'page', 'form_tpl' => 'fhg', ); $request = Array( 'method' => 'POST', 'path' => 'v1/adtool/type', '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); ?>