NAME

  VR::API - Communicate with VerticalResponse's API services

SYNOPSIS

  VR::API provides simplified access to the VerticalResponse API services server. It is
  based on the SOAP::Lite package, a widely-used SOAP toolkit for Perl.

Example

  #!/usr/bin/perl -w
  use strict;
  use VR::API;

  # SOAP::Lite uses Crypt::SSLeay for client-side certificate management.
  # perldoc Crypt::SSLeay for more documentation on how these environment
  # variables are used.
  $ENV{HTTPS_PKCS12_FILE} = "nickverticalresponsecom.p12";
  $ENV{HTTPS_PKCS12_PASSWORD} = "a_secret"; # Not needed for passphraseless PKCS#12 keystores

  my $vrapi = new VR::API;
  $vrapi->login( { username => 'nick@verticalresponse.com', password => 'another_secret' } );

  $vrapi->createList( {
      name => "A new list",
      type => "email",
  } );

Available functions

  See VR::API::_methods() for a list of available functions. 

References

  Enterprise API:

  https://api.verticalresponse.com/wsdl/1.0/VRAPI.wsdl
  https://api.verticalresponse.com/wsdl/1.0/documentation.html

  Partner API (requires a valid partner certificate):

  https://api.verticalresponse.com/partner-wsdl/1.0/VRAPI.wsdl
  https://api.verticalresponse.com/partner-wsdl/1.0/documentation.html

BUGS

  No known bugs. Please report bugs to api-support@verticalresponse.com

SEE ALSO

  Download and use the sash shell L<http://sash.sourceforge.net>.  There is a VerticalResponse
  plugin available that will help you learn and use the API more efficiently.

CREDITS

  Paul Kulchenko and Bryce Harrington, for writing a fantastic SOAP toolkit in Perl.

MAINTAINER

  Nick Marden <nick@verticalresponse.com>

COPYRIGHT

Copyright (C) 2007, Nick Marden, VerticalResponse Inc.

VR::API.pm is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

VR::API.pm is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA