Offerit API Ping

Offerit For Affiliates Automatic SubIDs Affiliate Stats Dumps Linkcode Link Groups Affiliate Custom Pixels Affiliate Host and Post Offerit Affiliate Area Affiliate Account Details Affiliate Account Change Log Affiliate Creatives Affiliate Creatives Search Affiliate Settings Affiliate Custom Pixels Affiliate Linkcodes Affiliate Linkcode Settings Affiliate Login History Affiliate Messages Affiliate Dashboard Dashboard Key Statistics Dashboard Statistics Summary Affiliate Payment History Quick Links Affiliate Referrals Report Affiliate Referring URL Report Affiliate Remote Login Affiliate Signup Affiliate Statistic Filters Affiliate Statistic Views Affiliate SubIDs Offerit Setup Creating Admin Accounts Tracking Domain Edit Affiliate Text Edit CSS Colors Getting Started Admin Offerit Quick-Start Guide Tracking in Offerit Pixel Builder Offerit Postback Examples Replacement Variables Currency Exchange Rates Admin Dashboard The Admin Dashboard Reporting Admin The Reporting Admin Track and Strack   Report Breakdowns Profit and Loss Report Subscription Report Transactions Reports Affiliate Ratios Report Affiliate Managers Report Visitor Actions Report Referral Tier Payouts Report Referral Signup Payouts Report Additional Commissions Report Graphical Affiliate Comparison Report The Single Day Comparison Report Actual Affiliate Payments Report Offers Admin The Offers Admin Offers Offer Setup Affiliate Referrals Tracking Domain Commissions Commission Changes Suppression Lists Pixel Builder ID Numbers Offer Partner Offer/Landing Page Redirection Setting Rules Admin Host and Post Offer Post URLs Offer Goals Affiliates Admin The Affiliates Admin ID Numbers Affiliate Managers Affiliate Referrals Affiliate Activation Admin-Only Settings Affiliate Overrides Creating Admin Accounts In-House Accounts Add Manual Sale Manual Invoice Affiliate Documents Affiliate Enabled Offers Change Affiliate Status Account Changes Advertisers Admin The Advertisers Admin Account Changes Advertiser Invoices Generate Invoice Advertiser Approval Change Advertiser Status Customers Admin Customers Admin Manually Adding a Customer ID Numbers Payments Admin The Payments Admin Payvia Types Payout Periods Payvia Dump Formats Payment Dump Entry Numbers Payment Dump Variables Check Functions Setting Rules Payment Methods Payza Creatives Admin The Creatives Admin Add New Creatives Add New Creative Type Offeritcode Code Builder Track and Strack Setting Rules   Default Creative Types Creative Types Image Banners Flash Banners Dynamic Text Banners Feeds Mailers Video Download Video Embed Page Peels IM Popups Footer Ads Page Ads Overlays Communications Admin The Communications Admin Add News Item Sending Messages Signup Questions Configuration Admin The Configuration Admin Affiliate Signup Postback URL Edit Affiliate Text Edit CSS Colors REST API General Offerit REST API Overview GET /service/ping PATCH /service/set_currency_exchange_rates Advertiser PATCH /advertiser/edit_advertiser POST /advertiser/add_advertiser Affiliate GET /affiliate/get_links GET /affiliate/get_single_link GET /affiliate/search GET /affiliate/decode_trackingcode PATCH /affiliate/edit_affiliate PATCH /affiliate/payvia POST /affiliate/add_affiliate POST /affiliate/affiliate_login_ips Config GET /config/get_global_void_ips GET /config/get_global_post_ips GET /config/get_global_hostnpost_ips POST /config/add_global_void_ip POST /config/remove_global_void_ip POST /config/add_global_post_ip POST /config/remove_global_post_ip POST /config/add_global_hostnpost_ip POST /config/remove_global_hostnpost_ip Creative GET /creative/get_creatives GET /creative/get_creative_fields GET /creative/get_creative_rules PATCH /creative/delete_creative PATCH /creative/edit_creative PATCH /creative/edit_creative_rules PATCH /creative/undelete_creative POST /creative/add_creative POST /creative/add_creative_rule POST /creative/delete_creative_rules Customer PATCH /customer/set_customer_details PATCH /customer/lock PATCH /customer/unlock PATCH /customer/forget GET /customer/export Offer GET /offer/get_conversion_caps GET /offer/check_orderid_exists GET /offer/get_commission_changes GET /offer/get_details PATCH /offer/activate_offer PATCH /offer/edit_landing_page PATCH /offer/edit_offer PATCH /offer/pause_offer PATCH /offer/set_commission_change_payouts PATCH /offer/set_enabled_affiliates PATCH /offer/set_offer_categories PATCH /offer/set_offer_countries PATCH /offer/set_offer_goals PATCH /offer/set_offer_groups PATCH /offer/set_offer_marketing_types PATCH /offer/store_offer_ips POST /offer/add_commission_change POST /offer/add_landing_page POST /offer/add_offer POST /offer/add_tracking_domain Reporting GET /report/profitloss GET /report/transaction Transaction GET /transaction/transaction_payout_preview PATCH /transaction/transaction_update_revenue_by_orderid PATCH /transaction/transaction_update_revenue_by_transaction_hash POST /transaction/process_void POST /transaction/process_chargeback POST /transaction/process_reversal POST /transaction/approve_pending_transaction GET /transaction/click_detail SOAP API (*deprecated*) API Add Affiliate Add Affiliate Sale Add Offer Approve Transaction Creative Types Decode Offeritcode Deny Transaction Disable Affiliate Landing Page Edit Affiliate Sale Enable Affiliate Landing Page Get Affiliate Stats Get Allowed Affiliates Get Landing Page Details Get Offer Details Get Offer List Get Profit Loss Report List Affiliate Details List Affiliate Subaffiliates Ping Set Affiliate Status Set SubAffiliate Status Set Member Details Record Affiliate Click Misc. Rules Freeform Date Affiliate Custom Signup Offeritcode Tracking in Offerit Offerit Logos Void Conversions Remotely

Ping is a test function to make sure that you can successfully connect to the API.

<?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:offeritapiadmin_wsdl"><SOAP-ENV:Body><tns:ping xmlns:tns="urn:offeritapiadmin_wsdl"></tns:ping>
	</SOAP-ENV:Body></SOAP-ENV:Envelope>

You will get a response similar to the following:

<?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/">
	<SOAP-ENV:Body><ns1:pingResponse xmlns:ns1="urn:offeritapiadmin_wsdl"><return xsi:type="xsd:boolean">true</return>
	</ns1:pingResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>

NuSOAP Example

This example continues from the main article NuSOAP Example):

$values = Array();
   
$result = $client->call('ping', Array(), 'offeritapiadmin_wsdl');

Sample Output

on success:
      1
   
on failure:
      <no output>