Difference between revisions of "NATS5 REST API Site GET site-type"

From TMM Wiki
Jump to: navigation, search
Line 25: Line 25:
 
** required
 
** required
  
 +
== '''Example Request''' ==
 +
Method: '''GET'''<br/>
 +
URL: <nowiki>http://domain/api/site/site-type</nowiki><br/>
 +
Query String: <nowiki>siteid=2</nowiki><br/>
 +
 +
Response:
 +
<pre>
 +
{
 +
    "success": true,
 +
    "site_type": {
 +
        "type": "0",
 +
        "name": "Membership",
 +
        "description": "<b>Membership<\/b><br>Pass-Protected Recurring and\/or Non-Recurring Sites",
 +
        "url": {
 +
            "hidden": 0
 +
        },
 +
        "third": false,
 +
        "billers": true,
 +
        "linkdomain": {
 +
            "hidden": 0
 +
        },
 +
        "options": true,
 +
        "cascades": true,
 +
        "members": true,
 +
        "partners": true,
 +
        "nosite_fields": {
 +
            "name": {
 +
                "name": "name",
 +
                "display": "Title",
 +
                "required": true
 +
            },
 +
            "description": {
 +
                "name": "description",
 +
                "display": "Description",
 +
                "required": false
 +
            },
 +
            "disclaimer": {
 +
                "name": "disclaimer",
 +
                "display": "Disclaimer",
 +
                "required": false
 +
            },
 +
            "active_all": {
 +
                "name": "active_all",
 +
                "display": "Active by Default",
 +
                "type": "checkbox"
 +
            }
 +
        },
 +
        "extra_outgoing_sale_gateway_fields": {
 +
            "disable_ssl_verify": {
 +
                "name": "disable_ssl_verify",
 +
                "display": "Disable SSL Verify",
 +
                "type": "checkbox",
 +
                "required": false
 +
            }
 +
        },
 +
        "incoming_sale_fields": [
 +
            "name",
 +
            "initial",
 +
            "initial_days",
 +
            "rebill",
 +
            "rebill_days",
 +
            "packageid"
 +
        ],
 +
        "extra_incoming_sale_fields": {
 +
            "package_excluded_optionid": {
 +
                "name": "package_excluded_optionid",
 +
                "display": "Equivalant Join Option",
 +
                "type": "select",
 +
                "required": false
 +
            }
 +
        },
 +
        "tour_overview_pages": {
 +
            "details": true,
 +
            "pages_steps": true,
 +
            "billers": true,
 +
            "email": true,
 +
            "posts": true,
 +
            "templates": true,
 +
            "linkcodes": true,
 +
            "members": true
 +
        }
 +
    }
 +
}
 +
</pre>
 +
 +
 +
  
 
== '''Example Code''' ==
 
== '''Example Code''' ==
Line 38: Line 125:
 
$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
+
'siteid' => '2',
 
);
 
);
  
Line 84: Line 171:
 
[[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:10, 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




GET /site/site-type

Description

  • Get site type

Resource URL

  • http://domain/api/site/site-type
  • Replace domain with the nats domain

Request Method

  • GET

Response Format

  • JSON

Authentication

  • HTTP headers

Parameters

Parameters can be sent as url encoded params

  • siteid
    • type: digit
    • required

Example Request

Method: GET
URL: http://domain/api/site/site-type
Query String: siteid=2

Response:

{
    "success": true,
    "site_type": {
        "type": "0",
        "name": "Membership",
        "description": "<b>Membership<\/b><br>Pass-Protected Recurring and\/or Non-Recurring Sites",
        "url": {
            "hidden": 0
        },
        "third": false,
        "billers": true,
        "linkdomain": {
            "hidden": 0
        },
        "options": true,
        "cascades": true,
        "members": true,
        "partners": true,
        "nosite_fields": {
            "name": {
                "name": "name",
                "display": "Title",
                "required": true
            },
            "description": {
                "name": "description",
                "display": "Description",
                "required": false
            },
            "disclaimer": {
                "name": "disclaimer",
                "display": "Disclaimer",
                "required": false
            },
            "active_all": {
                "name": "active_all",
                "display": "Active by Default",
                "type": "checkbox"
            }
        },
        "extra_outgoing_sale_gateway_fields": {
            "disable_ssl_verify": {
                "name": "disable_ssl_verify",
                "display": "Disable SSL Verify",
                "type": "checkbox",
                "required": false
            }
        },
        "incoming_sale_fields": [
            "name",
            "initial",
            "initial_days",
            "rebill",
            "rebill_days",
            "packageid"
        ],
        "extra_incoming_sale_fields": {
            "package_excluded_optionid": {
                "name": "package_excluded_optionid",
                "display": "Equivalant Join Option",
                "type": "select",
                "required": false
            }
        },
        "tour_overview_pages": {
            "details": true,
            "pages_steps": true,
            "billers": true,
            "email": true,
            "posts": true,
            "templates": true,
            "linkcodes": true,
            "members": true
        }
    }
}



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(
	'siteid' => '2',
);

$request = Array(
	'method' => 'GET',
	'path' => 'v1/site/site-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);
?>