Difference between revisions of "NATS5 REST API Site POST site-tour"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''POST /site/site-tour''' == '''Description''' * Add new site and default tour '''Resource URL''' *<nowiki>http://domai...") |
|||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_site_section = true |
}} | }} | ||
== '''POST /site/site-tour''' == | == '''POST /site/site-tour''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Add new site and default tour | * Add new site and default tour | ||
| 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 31: | Line 32: | ||
** required | ** required | ||
* '''site_hidden''' | * '''site_hidden''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''site_group_id''' | * '''site_group_id''' | ||
| Line 41: | Line 42: | ||
* '''date_added''' | * '''date_added''' | ||
** type: datetime (A date string to be parsed by php strtotime, or a unix timestamp integer) | ** type: datetime (A date string to be parsed by php strtotime, or a unix timestamp integer) | ||
| − | ** optional (default value: | + | ** optional (default value: 1565384489) |
* '''tour''' | * '''tour''' | ||
** type: string | ** type: string | ||
| Line 58: | Line 59: | ||
** optional | ** optional | ||
| − | [[Category: | + | == '''Example Request''' == |
| − | [[Category: | + | Method: '''POST'''<br/> |
| + | URL: <nowiki>http://domain/api/site/site-tour</nowiki><br/> | ||
| + | Form Data:<br/> | ||
| + | * site: testSite | ||
| + | * site_name: test site name | ||
| + | * site_type: 0 | ||
| + | * site_hidden: 0 | ||
| + | * site_group_id: 0 | ||
| + | * brand_id: 0 | ||
| + | * date_added: 1559932173 | ||
| + | * tour: testTour | ||
| + | * tour_name: test tour name | ||
| + | * tour_url: http://toomuchmedia.com | ||
| + | * tour_linkdomain: http://democash.com | ||
| + | * tour_description: test tour description | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "site": { | ||
| + | "siteid": "2", | ||
| + | "networkid": "0", | ||
| + | "site": "testSite", | ||
| + | "deleted": "0", | ||
| + | "name": "test site name", | ||
| + | "type": "0", | ||
| + | "hidden": "0", | ||
| + | "date_added": "1559932173", | ||
| + | "date_live": "0", | ||
| + | "network": "0", | ||
| + | "reuse_active": "0", | ||
| + | "no_personal_member_info": "0", | ||
| + | "mobile_tour": "0", | ||
| + | "site_group_id": "0", | ||
| + | "featured": "0", | ||
| + | "brand_id": "0", | ||
| + | "require_atvod_verification": "0", | ||
| + | "atvod_client_id": "", | ||
| + | "atvod_operator_id": "", | ||
| + | "atvod_password": "", | ||
| + | "atvod_authenticate_profile_id": "", | ||
| + | "atvod_passport_profile_id": "", | ||
| + | "atvod_driving_licence_profile_id": "", | ||
| + | "type_nice": "Membership", | ||
| + | "mobile_tour_nice": "None Selected", | ||
| + | "site_group_nice": "None" | ||
| + | }, | ||
| + | "tourid": 2, | ||
| + | "success": true, | ||
| + | "result": "Site and default tour added" | ||
| + | } | ||
| + | </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( | ||
| + | 'site' => 'testSite', | ||
| + | 'site_name' => 'test site name', | ||
| + | 'site_type' => 0, | ||
| + | 'site_hidden' => 0, | ||
| + | 'site_group_id' => 0, | ||
| + | 'brand_id' => 0, | ||
| + | 'date_added' => '1559932173', | ||
| + | 'tour' => 'testTour', | ||
| + | 'tour_name' => 'test tour name', | ||
| + | 'tour_url' => 'http://toomuchmedia.com', | ||
| + | 'tour_linkdomain' => 'http://democash.com', | ||
| + | 'tour_description' => 'test tour description', | ||
| + | ); | ||
| + | |||
| + | $request = Array( | ||
| + | 'method' => 'POST', | ||
| + | 'path' => 'v1/site/site-tour', | ||
| + | '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_site_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 16:01, 9 August 2019
POST /site/site-tour
Description
- Add new site and default tour
Resource URL
- http://domain/api/site/site-tour
- Replace domain with the nats domain
- POST
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- site
- type: string
- required
- site_name
- type: string
- optional
- site_type
- type: digit
- required
- site_hidden
- type: boolean_digit (0 or 1)
- optional
- site_group_id
- type: digit
- optional
- brand_id
- type: digit
- optional
- date_added
- type: datetime (A date string to be parsed by php strtotime, or a unix timestamp integer)
- optional (default value: 1565384489)
- tour
- type: string
- required
- tour_name
- type: string
- optional
- tour_url
- type: string
- required
- tour_linkdomain
- type: string
- required
- tour_description
- type: string
- optional
Example Request
Method: POST
URL: http://domain/api/site/site-tour
Form Data:
- site: testSite
- site_name: test site name
- site_type: 0
- site_hidden: 0
- site_group_id: 0
- brand_id: 0
- date_added: 1559932173
- tour: testTour
- tour_name: test tour name
- tour_url: http://toomuchmedia.com
- tour_linkdomain: http://democash.com
- tour_description: test tour description
Response:
{
"site": {
"siteid": "2",
"networkid": "0",
"site": "testSite",
"deleted": "0",
"name": "test site name",
"type": "0",
"hidden": "0",
"date_added": "1559932173",
"date_live": "0",
"network": "0",
"reuse_active": "0",
"no_personal_member_info": "0",
"mobile_tour": "0",
"site_group_id": "0",
"featured": "0",
"brand_id": "0",
"require_atvod_verification": "0",
"atvod_client_id": "",
"atvod_operator_id": "",
"atvod_password": "",
"atvod_authenticate_profile_id": "",
"atvod_passport_profile_id": "",
"atvod_driving_licence_profile_id": "",
"type_nice": "Membership",
"mobile_tour_nice": "None Selected",
"site_group_nice": "None"
},
"tourid": 2,
"success": true,
"result": "Site and default tour added"
}
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(
'site' => 'testSite',
'site_name' => 'test site name',
'site_type' => 0,
'site_hidden' => 0,
'site_group_id' => 0,
'brand_id' => 0,
'date_added' => '1559932173',
'tour' => 'testTour',
'tour_name' => 'test tour name',
'tour_url' => 'http://toomuchmedia.com',
'tour_linkdomain' => 'http://democash.com',
'tour_description' => 'test tour description',
);
$request = Array(
'method' => 'POST',
'path' => 'v1/site/site-tour',
'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);
?>
