Difference between revisions of "Freeside:1.9:Documentation:Developer:SelfService"

From Freeside
Jump to: navigation, search
(Sample Code)
Line 1: Line 1:
== Introduction ==
+
= Introduction =
 
The Self Service API provides an interface for customer management systems to interact with Freeside.  The Self Service API will support any language with a correct XML-RPC implementation.  The Freeside distribution includes sample code and libraries for perl, PHP, and Java.
 
The Self Service API provides an interface for customer management systems to interact with Freeside.  The Self Service API will support any language with a correct XML-RPC implementation.  The Freeside distribution includes sample code and libraries for perl, PHP, and Java.
  
== File Locations, Documentation and Sample Code ==
+
= File Locations, Documentation and Sample Code =
 
The files are located in '''freeside/fs_selfservice/'''
 
The files are located in '''freeside/fs_selfservice/'''
 
* '''FS-SelfService''' - Stock Self Service Interface
 
* '''FS-SelfService''' - Stock Self Service Interface
Line 9: Line 9:
 
* '''java''' - sample Java code
 
* '''java''' - sample Java code
  
== API Documentation ==
+
= API Documentation =
 
[[Freeside:1.9:Documentation:Developer/FS/SelfService|FS::SelfService API]]
 
[[Freeside:1.9:Documentation:Developer/FS/SelfService|FS::SelfService API]]
  
== Language Specific Documentation ==
+
= Language Specific Documentation =
=== Perl ===
+
== Perl ==
 
*Install the self service interface per the Installation Instructions.
 
*Install the self service interface per the Installation Instructions.
 
*The [[Freeside:1.9:Documentation:Developer/FS/SelfService|API Documentation]] is written for a Perl audience and includes sample code.
 
*The [[Freeside:1.9:Documentation:Developer/FS/SelfService|API Documentation]] is written for a Perl audience and includes sample code.
  
=== PHP ===
+
== PHP ==
 
=== Helper Class ===
 
=== Helper Class ===
Support for PHP is through the ''freeside.class.php'' file located in freeside/fs_selfservice/php.
+
Support for PHP is through the '''''freeside.class.php''''' file located in '''freeside/fs_selfservice/php'''.
  
 
* [[Freeside:1.9:Documentation:Developer/FS/SelfService/php/freeside.class.php|freeside.class.php]]
 
* [[Freeside:1.9:Documentation:Developer/FS/SelfService/php/freeside.class.php|freeside.class.php]]

Revision as of 19:32, 6 April 2010

Introduction

The Self Service API provides an interface for customer management systems to interact with Freeside. The Self Service API will support any language with a correct XML-RPC implementation. The Freeside distribution includes sample code and libraries for perl, PHP, and Java.

File Locations, Documentation and Sample Code

The files are located in freeside/fs_selfservice/

  • FS-SelfService - Stock Self Service Interface
  • php - sample php code
  • perl - sample perl code
  • java - sample Java code

API Documentation

FS::SelfService API

Language Specific Documentation

Perl

  • Install the self service interface per the Installation Instructions.
  • The API Documentation is written for a Perl audience and includes sample code.

PHP

Helper Class

Support for PHP is through the freeside.class.php file located in freeside/fs_selfservice/php.

Be sure to set the correct URL to point to your Freeside server.

Sample Code