Difference between revisions of "NATS5 REST API Site POST site-tour"

From TMM Wiki
Jump to navigationJump to search
Line 41: Line 41:
 
* '''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: 1559932173)
+
** optional (default value: 1562602235)
 
* '''tour'''
 
* '''tour'''
 
** type: string
 
** type: string
Line 58: Line 58:
 
** optional
 
** optional
  
 +
== '''Example Request''' ==
 +
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''' ==
 
== '''Example Code''' ==
Line 71: Line 127:
 
$url = 'http://yourdomain.com'; //set your NATS URL here
 
$url = 'http://yourdomain.com'; //set your NATS URL here
  
$data = array(
+
$data = Array(
// Add API parameters here
+
'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',
 
);
 
);
  
Line 117: Line 184:
 
[[Category:NATS4_REST_site_Collection]]
 
[[Category:NATS4_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:Missing_Autogenerated_Rest_Sample]]<!-- This article is missing 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 -->

Revision as of 12:11, 8 July 2019

NATS 4
Members Admin
The Members Admin
View Member Details
Add Member
MySQL Auth
Mod Authn DB
Multisite Access
Member Logging
Member Password Retrieval
OpenID Connect
Mod Auth OpenIDC
ID Numbers
SOAP API
API
API Best Practices
WSDL Cache
Add Affiliate
Add Member Note
Admin Get Adtools
Adtool Categories
Adtool Types
Affiliate Get Campaigns
Bulk Import Adtools
Caching
Decode Natscode
Expire Manual Member
Get Affiliate Campaigns
Get Affiliate Hit Data
Get Affiliate Loginids
Get Affiliate Nats Codes
Get Affiliate Payout
Get Affiliate Program Campaign List
Get_Affiliate_Program_Campaign_List
Get Member Details
Get Member Instant Upgrade String
Get Member Package Upgrade String
Get Member Token Rebuy String
Get Member Upsell String
Get Payment Data
Get Payvia Rule
Get Profit Loss Report
Ping
Record Member Login
Search Affiliate Info
Search Member Info
Send Email API Function
Set Affiliate Admin Settings
Set Affiliate Customs
Set Affiliate Defaults
Set Affiliate Information
Set Affiliate Settings
Set Member Details
Set Payment Status
Set Payvia Rule
REST API
API Overview
API Best Practices
REST API PATH UPDATES
Adtools
GET /adtools/admin
GET /adtools/categories
GET /adtools/types
POST /adtools/importdump
Affiliate
GET /affiliate/campaigns
GET /affiliate/hitdata
GET /affiliate/payout
GET /affiliate/searchinfo
POST /affiliate/addaffiliate
POST /affiliate/invoice
PATCH /affiliate/setadminsettings
PATCH /affiliate/setcustoms
PATCH /affiliate/setdefaults
PATCH /affiliate/setinformation
PATCH /affiliate/setpayviainfo
PATCH /affiliate/setsettings
PATCH /affiliate/status
Member
GET /member/authstring
GET /member/details
GET /member/searchinfo
GET /suggestedcanceloffers
PATCH /member/setdetails
PATCH /member/setexpiration
POST /member/addnote
POST /member/recordlogin
PUT /member/expiremanual
PATCH /member/forget
Option
GET /option/options
GET /option/rule
PATCH /option/rule
PATCH/option/text
POST /option/rule
Payments
GET /payments/getpayments
GET /payviarule
PATCH /payments/setstatus
PATCH /payviarule
Report
GET /profitlossreport
Get /transactionpayouts
GET /report/transaction
Service
GET /service/decodenatscode
GET /service/ping
POST /service/sendemail

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

Request Method

  • POST

Response Format

  • JSON

Authentication

  • 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
    • 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: 1562602235)
  • 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);
?>