wms_webservices_linkcodegenerator
DESCRIPTION
WMS WebServices LinkCodeGeneratorTRANSCRIPT
COPYRIGHT©
2010, CCBILL, LLC
V.1; FEBRUARY, 2010 Page 1 of 4
WMS Web Services Link Code Generator
Implementation Guide
COPYRIGHT©
2009, CCBILL, LLC
V.1;JULY, 2009 Page 2 of 4
PURPOSE
The Web Marketing Service (WMS) Web Services Link Code Generator is intended to provide Link Code and Referral Code to your Affiliates directly from your Web site so that your Affiliate can obtain link code for your WMS programs without logging in to the Affiliate Admin or the Admin Portal.
SCOPE
This document is an Implementation Guide and is written for users with HTML experience. The information provided in this document is intended to be inserted into your own Web pages.
REQUIREMENTS
You will need to provide your own HTML coded page in which you will insert the following tags for Link Code generation.
Note: Any instance of “XYZ” is intended to be read as a variable. You will replace the XYZ (or XYZ URL) with your own custom information.
Page Code Tags
Code: <script type='text/javascript' language="javascript" src='https://datalink.ccbill.com/wmsws/wms_web_service_methods.jsp'></script>
Required: Yes
Location: Just before the </head> tag.
Purpose: Loads all of the JavaScript Web Services code necessary to look up the link information and present it on the page.
Code: onload="fillWmsInfo()"
Required: Yes
Location: In the <body> tag of your site.
Purpose: This allows the form to be updated to its previous state when a user navigates away from the page and then returns.
Form Code Tags
Code: <form id="wmsForm1" onSubmit="return wmsInit(this);">
Required: Yes
Location: Form
Purpose: Submits the form to our WMS system to return the appropriate values.
Code: <input type="text" name="ccbillMainAffiliateId" value="XYZ">
Required: Yes
Location: Form
Purpose: Provides an entry field for Affiliates to enter their Affiliate ID and a button for submission of that Affiliate ID.
COPYRIGHT©
2009, CCBILL, LLC
V.1;JULY, 2009 Page 3 of 4
Code: <input type="hidden" name="programId" value="XYZ"/>
Required: Yes
Location: Form
Variable: Program ID
Purpose: Identifies the WMS Program ID to generate links for on the page. WMS Program IDs can only be obtained from Client Support at this time.
Code: <a href="http://XYZURL/webmaster_referral.php?wms=%ppId" id="wms_customReplaceImage_1">
Required: Optional
Location: Form
Purpose: This is the Custom URL Builder. This is similar to the Custom Link Replacement, though no hidden tag is required. You will provide the replacement information in the href of value of the HTML tag (also works with text areas).
Currently this can only replace the %ppId, however this will be expanded in a future release.
WMS Parameters
Code:
Required: Optional
Location: Form
Variable: The variable for this parameter is the Affiliate ID.
Purpose: This loads chosen parameters to include anywhere on the page with HTML tags that support values;, such as the <span> tag or an anchor tag.
Available tags include:
wms_clickUrl_1
The WMS Click-Thru and Cookie Generation Link Code.
wms_impressionUrl_1
The WMS Impression Link Code.
wms_programParticipationId_1"
The Affiliate’s Program Participation ID for the Program ID on the form.
wms_isEncrypted_1
If the cookie is encrypted. If encrypted, programParticipationId is not provided.
wms_encryptedString_1
The encrypted value of the cookie (w_id in WMS Link Click-Thru).
Implementation Example:
<span id="wms_programParticipationId_1">XYZ</span>
COPYRIGHT©
2009, CCBILL, LLC
V.1;JULY, 2009 Page 4 of 4
Code: <input type="hidden" id="wms_customReplaceImage_1_value" value="XYZ URL">
Required: Optional; Advanced
Location: Form
Variable: HREF URL
Purpose: The Custom Link Replacement tag defines the URL that should be replaced in the target link for consumers on the Affiliate Site.
The number _1_ can be incremented to allow for multiple custom replacements. There is no limit to the number of Custom Link Replacement tags you can use but they MUST increment by exactly one for each instance; you may not skip integers.
This is the URL that is displayed as the href in the link code.
SUPPORT
Further support is available from our Client Support Representatives should you need assistance with implementing this feature. Client Support can be contacted via:
Email: [email protected] Phone: 800.510.2859 Online Chat: https://admin.ccbill.com/login.cgi, then click Contact CCBill at the
top, or click this link.