developer:soap:howto:vb2010

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
developer:soap:howto:vb2010 [2009/12/29 14:43]
tem
developer:soap:howto:vb2010 [2010/01/22 11:53] (current)
nell copyedit
Line 7: Line 7:
 To add a service reference to a project in Visual Studio To add a service reference to a project in Visual Studio
  
-  * In the "​Solution Explorer", select the project that will be using the usaepay ​service. +  * In the "​Solution Explorer," ​select the project that will be using the USAePay ​service. 
-  * Right-click on the project and choose "Add Service Reference".+  * Right-click on the project and choose "Add Service Reference."
  
-{{:​developer:​soap:​howto:​addreference2010.png|}}+|{{:​developer:​soap:​howto:​addreference2010.png|}}|
  
-  * The "Add Service Reference"​ dialog box will open +  * The "Add Service Reference"​ dialog box will open
  
-  * Populate the URL field with your USAePay generated WSDL link. For testing on sandbox you can use https://​sandbox.usaepay.com/​soap/​gate/​3213EA2A/​usaepay.wsdl ​ but it is recommend that you generate your own wsdl link in the [[https://​www.usaepay.com/​developer/​|Developer Portal]] +  * Populate the URL field with your USAePay generated WSDL link. For testing on sandbox you can use https://​sandbox.usaepay.com/​soap/​gate/​3213EA2A/​usaepay.wsdl but it is recommend that you generate your own wsdl link in the [[https://​www.usaepay.com/​developer/​|Developer Portal]]. 
-  * Click 'Go+  * Click "Go."
-{{:​developer:​soap:​howto:​addservicereferencego.png|}}+
  
-  * Change the namespace to '​usaepay'​ and then click '​OK'​ +|{{:​developer:​soap:​howto:​addservicereferencego.png|}}|
-{{:​developer:​soap:​howto:​namespace.png|}} +
-  * You have now added a service reference called "​usaepay" ​ to your project.+
  
-===== Using the Web Service Reference =====+  * Change ​the namespace to "​usaepay"​ and then click "​OK."​
  
-To use the USAePay web reference, ​ you must generate ​a "token" ​ which authenticates ​your application to the gateway  This requires generating an MD5 hash value. ​ The following steps walk through ​the process of creating this token. ​ Once the token is created, ​ running specific methods is fairly easy.  For examples of a specific methods, ​ please refer to the examples provide on each methods pages. ​ An index of available methods is available [[developer:​soap|here]].+|{{:​developer:​soap:​howto:​namespace.png|}}| 
 + 
 +  * You have now added service reference called ​"usaepay" ​to your project. 
 + 
 +===== Using the Web Service Reference =====
  
 +To use the USAePay web reference, you must generate a "​token"​ which authenticates your application to the gateway. This requires generating an MD5 hash value. The following steps walk through the process of creating this token. Once the token is created, running specific methods is fairly easy. For examples of specific methods, please refer to the examples provided on each method'​s page. An index of current methods is available [[developer:​soap|here]].
  
-==== Step 1: Including ​required ​Imports =====+==== Step 1: Including ​Required ​Imports =====
  
-The generation of MD5 hash requires some .NET libraries ​be imported ​into your code.  Typically these import statements will go at the top of the your code.+The generation of an MD5 hash value requires ​that you import ​some .NET libraries into your code. Typically these import statements will go at the top of the your code.
  
 <code vb> <code vb>
Line 39: Line 41:
 </​code>​ </​code>​
  
-==== Step 2: Instantiating the client ​====+==== Step 2: Instantiating the Client ​====
  
-The next step is to instantiate the client object. In the soap examples provided on this site, we use the variable ​'client' ​for this object.+The next step is to instantiate the client object. In the soap examples provided on this site, we use the variable ​"client" ​for this object.
  
 <code vb> <code vb>
-Dim client As New usaepay.ueSoapServerPortTypeClient '​usaepay is the name of your Web Reference+Dim client As New usaepay.ueSoapServerPortTypeClient '​usaepay' ​is the name of your Web Reference
 </​code>​ </​code>​
  
Line 51: Line 53:
 ==== Step 2b:  Setting a Proxy Server (if needed) ==== ==== Step 2b:  Setting a Proxy Server (if needed) ====
  
-If your network requires you to use a proxy server, ​ the next step is to reference the proxy server. ​ If you do not have a proxy server, ​ skip this step.+If your network requires you to use a proxy server, the next step is to reference the proxy server. If you do not have a proxy server, skip this step.
  
 <code vb> <code vb>
Line 61: Line 63:
 </​code>​ </​code>​
  
-==== Step 3: Building Security ​token ====+==== Step 3: Building Security ​Token ====
  
-The ueSecurityToken object is used to securely identify the merchant to the gateway. ​ To build a token, ​ you will need the merchant'​s Source Key and Pin.  The source key is created by the merchant in the [[http://​wiki.usaepay.com/​merchant/​support|Merchant Console]] under the [[http://​wiki.usaepay.com/​merchant/​console/​sources|Settings - Sources]] ​ ​screen.  Many of the methods in the SOAP API require the use of a PIN, and it is recommended that you always use a PIN.  The merchant assigns the PIN when creating the source key.+The ueSecurityToken object is used to securely identify the merchant to the gateway. To build a token, you will need the merchant'​s Source Key and PIN.  The Source Key is created by the merchant in the [[http://​wiki.usaepay.com/​merchant/​support|Merchant Console]] under the [[http://​wiki.usaepay.com/​merchant/​console/​sources|Settings - Sources]] ​tab.  Many of the methods in the SOAP API require the use of a PIN, and it is recommended that you always use a PIN.  The merchant assigns the PIN when creating the Source Key.
  
 <code vb> <code vb>
Line 123: Line 125:
 ===== Additional Help ===== ===== Additional Help =====
  
-For questions please email devsupport@usaepay.com+For questions please email [[devsupport@usaepay.com]].
    
developer/soap/howto/vb2010.txt · Last modified: 2010/01/22 11:53 by nell

Page Tools