Setting Up Authentication Parameters

The API calls that you make to the Vindicia servers use SOAP over SSL, which encrypts the data that travels between your servers and Vindicia’s, and renders the data tamper-proof en route. To ensure that the calls originate from a legitimate source, Subscribe requires that each call include authentication. The Authentication object contains a SOAP user name and password, which are provided to you by Vindicia Client Services, and which vary between the production and test environments. If you generate API calls directly through the Subscribe WSDL files without using any client libraries, you must include the Authentication object in your calls to Vindicia. By using a Vindicia client library, however, you need not do so. The client library enables you to globally configure the authentication parameters (the SOAP user name and password), automatically construct the Authentication object, and pass it in with your calls. Some libraries, such as Java and PHP, also enable you to specify authentication parameters during the process of constructing a target object on which to make calls. The following subsections describe how authentication parameters operate in the client libraries. The concepts are illustrated through the construction of the commonly used Transaction object.

In Perl

Create a Transaction in a Perl program: Set your Vindicia user name and password variables:

$login = "MyVindiciaLogin";
$password = "MyVindiciaPassword";

Create a new Transaction:

my $tx = Vindicia::Soap::Transaction->
new(auth_login => $login, auth_password => $password); 

where MyVindiciaLogin and MyVindiciaPassword are the SOAP user name and password, respectively, assigned to you by Vindicia.

In PHP

In the PHP library, edit the Const.php file in the Vindicia/Soap directory to change the values of the global constants that contain the Vindicia SOAP login and password. Change the values of the following constants:

define("VIN_SOAP_CLIENT_USER", "your username here");
define("VIN_SOAP_CLIENT_PASSWORD", "your password here");

Then, you can instantiate an object, such as Transaction, as follows: $txn = new Transaction();

In Java

Create a Transaction in Java:

/ Create a new transaction
String username = "MyVindiciaLogin";
String password = "MyVindiciaPassword";
com.vindicia.client.Transaction transaction = 
   new com.vindicia.client.Transaction(username, password);

where MyVindiciaLogin and MyVindiciaPassword are the SOAP user name and password, respectively, assigned to you by Vindicia. You may also globally set the SOAP user name and password for making Subscribe API calls in the Java library. Define the constants in the com.vindicia.client.ClientConstants class as follows:

com.vindicia.client.ClientConstants.SOAP_LOGIN = "my_soap_user_name";
com.vindicia.client.ClientConstants.SOAP_PASSWORD = "my_soap_password";

If you set the SOAP user name and password globally, use object constructors that do not take those values as their parameters.

In VB

In VB, you must create an object and allocate space for it before sending the authentication information.

To create a new Transaction object, type:

Create a new transaction
Dim transaction As New VindiciaCOM.CTransaction()

After creating the Transaction, initialize your authentication data and call the SetAuthenticationInfo method for the Transaction object. Type:
Dim username = "MyVindiciaLogin" Dim password = "MyVindiciaPassword" transaction.SetAuthenticationInfo(username, password)
where MyVindiciaLogin and MyVindiciaPassword are the SOAP user name and password, respectively, assigned to you by Vindicia.

In C#

In C#, the Vindicia namespace includes an object called Environment, which enables you to set the SOAP endpoint server and authentication. For example:

string login = "MyVindiciaLogin";
string password = "MyVindiciaPassword"; 

// This method allows you to change the server you connect to 
Vindicia.Environment.SetEndpoint("soap.staging.us-west.vindicia.com"); 

// This method allows you to set your auth info once 
Vindicia.Environment.SetAuth(login, password);

where MyVindiciaLogin and MyVindiciaPassword are the SOAP user name and SOAP password, respectively, assigned to you by Vindicia. Parent topic:Support for Development

Home

Guides

APIs

In Perl

In PHP

In Java

In VB

In C#

​In Perl

​In PHP

​In Java

​In VB

​In C#

In Perl

In PHP

In Java

In VB

In C#