NATS4 API Ping

From Tmmwiki

NATS 4 About NATS 4 NATS4 Requirements IPSP Integration For Affiliates Affiliate Adtools Automatic Campaigns Affiliate Payment Information Affiliate Defaults Affiliate Link Codes Affiliate Stats Dumps ASP Query String Main Program Page NATS4 Upgrade Changelog Administration Changes Admins Admin Overview Reports Admin Payments Admin News and Notifications Admin Affiliates Admin Members Admin Sites Admin Difference between NATS4 and NATS3 Postback URL Programs Admin Billers Admin Third-Party Admin Adtools Admin Upsells Admin Includes Admin Mailing Admin Skins & Templates Admin Configuration Admin Cleanup and Maintenance Admin Logs Admin Affiliate Changes Affiliate Overview Affiliate Stats Affiliate Adtools Affiliate My Account Affiliate Payments NATS Setup Post-Installation Steps Apache Configuration MySQL Settings Creating Admin Accounts Multiple Server Setup Using Memcached for Caching File Upload Setup Link Domain NATS4 Files and Directories NATS Go Live Checklist NATS3 to NATS4 Going Live Checklist Moving NATS4 Admin Overview The Admin Overview Reporting Admin The Reporting Admin track and strack Fraud Reports Actual Affiliate Payments   Report Breakdowns The Profit and Loss Report The Retention Report The Subscription Report The Transactions Report The Detailed Trial Report The Cascade Activity Report The Fraud Report The Account Rep Report The Surfer Actions Report The Affiliate Referral Tier Payouts Report The Affiliate Referral Signup Payouts Report The Additional Payout Report The Graphical Affiliate Comparison Report The Single Day Comparison Report Payments Admin The Payments Admin Creating and Editing PayVia Options and Dump Formats Pay Via Types Check Functions Payment Dump Entry Numbers RevUpCard News and Notifications Admin The News and Notifications Admin Add News Item Send Notification Affiliates Admin The Affiliates Admin ID Numbers Account Representatives Affiliate Referrals Affiliate Activation Creating Admin Accounts In-House Accounts Affiliate-Specific Join Options and Payouts Add Manual Sale Change Affiliate Status Members Admin The Members Admin Add Member MySQL Auth Multisite Access ID Numbers Nats4 Member Logging Sites Admin The Sites Admin Sites Sites Setup Join Options No Cost Registration Join Option Rules Post URL Usage NATS4 Post URLs Token Sites ID Numbers Site Partner Site User Management Tour Redirection Username Checking NATS4 Post-Biller Templates Join Option Box vs Button Qualified Join Page Hits Type-In Traffic Allowed languages Programs Admin The Programs Admin NATS4 Adding Programs Payout Changes ID Numbers NATS Program Billers Admin The Billers Admin Biller Biller Fees NATS Cascades Add Cascade Cascade Weight Autocascade Hidden Cascades Geo-Targeting Cascades Post-Biller Templates HTTPS Gateways Timed Cascade Rules Upgrade Plus Gateway One Step Join   Biller Instructions NATS4 Biller List 2000Charge Aebill Authorize.net CCBill CCBill Web900 Clearcard CommerceGate CurePay DHD DHDGateway Epoch Gateway tokens Global Access Itelebill GlobalCharge Greta 11 (G11Bill) GXBill ICN Ltd. Jettis International LocalBilling NETbilling NETbilling Native NetCash Netpay International OrbitalPay Pay900 Payment Network Plug'n_Pay PayPal RocketGate SafeCharge SegPay Switching From Epoch to Epoch EU WebBilling WTS WTSeu Zombaio Third Party Admin NATS Third Parties AdultFriendFinder AdultFriendFinderAPI   AdultFriendFinder versus AdultFriendFinderAPI Adtools Admin The Adtools Admin Duplicating Adtool Types New Downloadable Content Adtool Type Get Hosted Galleries Adtool Templates Content of the Day NATS4 Flash Banners Upsells Admin The Upsells Admin NATS4 Process Gateway Cross Sales Outside NATS Includes Admin The Includes Admin The Promotionals Admin Mailing Admin The Mailing Admin NATS Email Configuration The Mailing Queue Mailer Template Variables Mass Mailing Template Variables Common Mailer Examples Skins and Templates Admin The Skins and Templates Admin Skins Smarty Plugins Templates custom_errors.php NATS4 Post URL Variables Member Usernames & Passwords Username Recommendations Password Retrieval Post-Biller Templates Geo-Target Join Options Random Usernames and Passwords Smarty Smarty print array Affiliate Support Template Adding a Verification Image Custom Program and Campaign Selection Pages Output An Affiliate's Last Paid Date Affiliate Signup Email   Template Functions nats_add_to_array nats_adtool_replace_linkcode nats_array_flip nats_array_to_xml nats_build_array_by_reference nats_convert_bytes nats_decode nats_display_account_campaigns nats_display_account_change_history nats_display_account_notifications nats_display_account_preview nats_display_admin_links nats_display_admin_message nats_display_adtool_form nats_display_adtool_types nats_display_adtools nats_display_adtools_type_limit nats_display_choose_adtools_group nats_display_code_info nats_display_create_campaign nats_display_edit_account_details nats_display_edit_account_settings nats_display_edit_defaults nats_display_edit_password nats_display_edit_payvia nats_display_edit_payvia_info nats_display_edit_skin nats_display_gallery_builder nats_display_graph nats_display_hourly_sales nats_display_latest_adtools nats_display_map nats_display_news nats_display_page_peel nats_display_payment_history nats_display_payment_summary nats_display_ratio nats_display_reward_category nats_display_reward_order nats_display_reward_purchases nats_display_signup_advanced nats_display_signup_basic nats_display_signup_payvia nats_display_stats nats_display_stats_calendar nats_display_stats_form nats_display_stats_referrals nats_display_stats_retention nats_display_stats_subscription_details nats_display_stats_table nats_display_timezones nats_display_top_stats nats_dump_data nats_encode nats_get_first_in_array nats_get_period_end nats_get_reward_categories nats_get_member nats_list_adtool_groups nats_list_affiliates nats_list_billers nats_list_campaigns nats_list_linkcodes nats_list_options nats_get_option_details nats_list_programs nats_list_sites nats_list_tool_categories nats_list_tours nats_list_xsells nats_smarty_function_amount_owed nats_smarty_function_getbonus nats_smarty_rebuild_form nats_smarty_rebuild_link nats_smarty_rebuild_query nats_tooltip tmm_admin_pagination Template Shortcuts add_to_array adtool_replace_linkcode affiliate_select_form array_flip array_to_xml amount_owed build_array_by_reference convert_bytes display_account_campaigns display_account_change_history display_account_notifications display_account_preview display_admin_links display_adtool_form display_adtool_types display_adtools display_adtools_type_limit display_choose_adtools_group display_code_info display_create_campaign display_gallery_builder display_stats_referrals display_edit_account_details display_edit_account_settings display_edit_defaults display_edit_password display_edit_payvia display_edit_payvia_info display_edit_skin display_graph display_hourly_sales display_latest_adtools display_map display_news display_page_peel display_payment_history display_payment_summary display_ratio display_reward_category display_reward_order display_reward_purchases display_signup_advanced display_signup_basic display_signup_payvia display_stats display_stats_calendar display_stats_table display_stats_form display_stats_retention display_stats_subscription_details display_top_stats display_timezones dump_data get_first get_period_end get_reward_categories list_billers list_campaigns list_linkcodes list_options list_programs list_sites list_tool_categories list_tours list_xsells rebuild_form rebuild_link rebuild_query reward_points tooltip Common Parameters assign assign_prefix count data_only display_on_assign start tpl NATS Configuration Admin The Configuration Admin Log Admin Activity IP Address Filtering MEMBER_EXPIRE_PAD Fraud Configuration NATS Email Configuration Affiliate Signup Email Affiliate Postback API NATS4 API Add Affiliate Admin Get Adtools Adtool Types Adtool Categories Ping Affiliate Get Campaigns Get Member Details Set Affiliate Defaults Set Affiliate Admin Settings Set Affiliate Customs Decode Natscode Set Affiliate Information Set Affiliate Settings Set Member Details Bulk Import Adtools Send Email API Function Misc. Admins NATS4 Database Cleanup Support Admin Logs Admin Rules Freeform Date Troubleshooting Common Errors Fix Graphs Auto Login AutoLogin Cookie Expired License Zend License CAPTCHA NATS Extras Gallery Builder Module Remote Affiliate Authentication Build Your Own Anything Module Shopping Cart Sales Moving Tours, Members' Area, and Galleries Admin Areas Extended Sales NATS Code Wordpress Plugin Error_message_display NATS4 Gateway Direct

Ping is a test function to make sure that you can successfully connect to the API. To perform a ping you must make a SOAP call with the following parameters:

<?xml version="1.0" encoding="ISO-8859-1"?>
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
xmlns:tns="urn:natsapiadmin_wsdl">
<SOAP-ENV:Body>
	<tns:ping xmlns:tns="urn:natsapiadmin_wsdl">
	</tns:ping>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

You will get a response similar to:

<?xml version="1.0" encoding="ISO-8859-1"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
	<ns1:pingResponse xmlns:ns1="urn:natsapiadmin_wsdl">
		<return xsi:type="xsd:boolean">true</return>
	</ns1:pingResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

NuSOAP Example (continuing from main article NuSOAP Example):

$result = $client->call('ping', Array(), 'natsapiadmin_wsdl');
var_dump($result);

Output:

bool(true)