Difference between revisions of "Freeside:1.9:Documentation:Developer:SelfService"
From Freeside
(→Sample Code) |
(→Reseller Documentation) |
||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | = 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 | + | The Self Service API provides an interface for customer management systems to interact with Freeside. The Self Service API will support any language with an 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/ | + | The files are located in '''freeside/fs_selfservice/''' |
* '''FS-SelfService''' - Stock Self Service Interface | * '''FS-SelfService''' - Stock Self Service Interface | ||
* '''php''' - sample php code | * '''php''' - sample php code | ||
| + | * '''drupal''' - Drupal module | ||
* '''perl''' - sample perl code | * '''perl''' - sample perl code | ||
* '''java''' - sample Java code | * '''java''' - sample Java code | ||
| − | + | = 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 | + | = Reseller Documentation = |
| − | + | [[Freeside:1.9:Documentation:Developer:SelfService:Reseller|Reseller]] | |
| + | |||
| + | = Language Specific Documentation = | ||
| + | == 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 == | |
=== 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]] | ||
| − | Be sure to set the correct URL to point to your Freeside server. | + | Be sure to set the correct URL to point to your Freeside self-service server. |
=== Sample Code === | === Sample Code === | ||
| − | * [[Freeside:1.9:Documentation:Developer/FS/SelfService/php/ | + | * [[Freeside:1.9:Documentation:Developer/FS/SelfService/php/php_examples|PHP Examples]] (including a simple renewal app) |
Latest revision as of 16:17, 11 November 2010
Contents
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 an 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
- drupal - Drupal module
- perl - sample perl code
- java - sample Java code
API Documentation
Reseller Documentation
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 self-service server.
Sample Code
- PHP Examples (including a simple renewal app)
