/api/member/details

get

Get member information

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Query parameters

memberidintegerOptional

sessionanyOptional

memberidxanyOptional

usernameanyOptional

siteidanyOptional

transactionidanyOptional

emailanyOptional

statusstringOptional

token_hashanyOptional

subscriptionidintegerOptional

subscriptionsstringOptional

transactionsstringOptional

blackliststringOptional

full_infostringOptional

all_datastringOptional

surfer_actionsstringOptional

loginlogsstringOptional

notesstringOptional

member_datastringOptional

ident_detailsstringOptional

igm_datastringOptional

create_missing_substringOptional

banned_historystringOptional

whitelist_historystringOptional

denied_loginlogsstringOptional

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

get

/api/member/details

PHP (cURL)

<?php

$headers = array( //set your username and API key here
	'api-key: 44b5498dbcb481a0d00b404c0169af62',
	'api-username: tmm1phrvezsbu'
);
$url = 'https://yourdomain.com'; //set your NATS URL here

$data = array(
		'memberid' => '3',
		'username' => 'test username',
		'siteid' => 1,
		'email' => '[email protected]'
	);

$request = array(
	'method' => 'GET',
	'path' => 'member/details',
	'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);
?>

200

success

{
  "memberid": "3",
  "identid": "4",
  "loginid": "0",
  "refurl_lookup_id": "2",
  "status": "1",
  "trial": "0",
  "joined": "1565382563",
  "expired": "0",
  "last_login": "1565382564",
  "stamp": "1565382564",
  "siteid": "1",
  "username": "test username",
  "password": "testPassword",
  "cryptpass": "d3695SDTr1h2k",
  "ip": "",
  "email": "[email protected]",
  "session": "4184eb9f9064c7b773c8dfd159505af4",
  "mailok": "1",
  "flat_price": "0",
  "first_login": "1565382564",
  "third_party_partner_id": "0",
  "cascadeid": "0",
  "cascade_item_id": "0",
  "token": "0",
  "original_username": "test username",
  "renamed": "0",
  "marked": "0",
  "token_hash": "f561384f9bf88197514d49fc321d5f85",
  "member_subscription_id": "3",
  "memberidx": "NATS:3",
  "billerid": "0",
  "statid": "75d4dd7a3ec43e",
  "cost": "0",
  "cost_charge": "0",
  "spent": "0",
  "refunded": "0",
  "charges": "0",
  "next_rebill": "0",
  "optionid": "0",
  "rebills": "0",
  "active": "1",
  "upgradeid": "",
  "expires": "1591329600",
  "nats_expires": "1591329600",
  "biller_expires": "0",
  "original_optionid": "0",
  "created_date": "1565382563",
  "ip_hex": "",
  "flagged": "0",
  "loginid_nice": false,
  "siteid_nice": "Membership Site A",
  "site_type": "0",
  "biller": false,
  "refurl": "No Referring URL"
}

patch

Update member information

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Query parameters

memberidanyOptional

memberidxanyOptional

subscriptionidanyOptional

trialintegerOptional

firstnameanyOptional

lastnameanyOptional

emailanyOptional

address1anyOptional

address2anyOptional

cityanyOptional

stateanyOptional

countryanyOptional

zipanyOptional

flaggedstringOptional

mailokstringOptional

passwordanyOptional

custom1anyOptional

custom2anyOptional

custom3anyOptional

custom4anyOptional

custom5anyOptional

custom6anyOptional

custom7anyOptional

custom8anyOptional

custom9anyOptional

custom10anyOptional

no_member_notestringOptionalDefault: 0

usernameanyOptional

expireanyOptional

display_nameanyOptional

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

patch

/api/member/details

PHP (cURL)

<?php

$headers = array( //set your username and API key here
	'api-key: 44b5498dbcb481a0d00b404c0169af62',
	'api-username: tmm1phrvezsbu'
);
$url = 'https://yourdomain.com'; //set your NATS URL here

$data = array(
		'memberid' => '3',
		'firstname' => 'testFirstname',
		'lastname' => 'testLastname',
		'memberidx' => 'NATS:3',
		'expire' => '2020-06-10',
		'email' => '[email protected]',
		'address1' => '123 address street',
		'city' => 'testCity',
		'state' => 'NJ',
		'country' => 'USA',
		'zip' => '12345'
	);

$request = array(
	'method' => 'PATCH',
	'path' => 'member/details',
	'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);
?>

200

success

{
  "result": "SUCCESS",
  "return": [
    "NATS:3 (3) was updated."
  ],
  "success": true
}