Difference between revisions of "Freeside:1.9:Documentation:Developer:SelfService"
From Freeside
(→Reseller Documentation) |
|||
| (6 intermediate revisions by the same user not shown) | |||
| 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 | + | 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 = | = File Locations, Documentation and Sample Code = | ||
| Line 6: | Line 6: | ||
* '''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 | ||
| Line 11: | Line 12: | ||
= API Documentation = | = API Documentation = | ||
[[Freeside:1.9:Documentation:Developer/FS/SelfService|FS::SelfService API]] | [[Freeside:1.9:Documentation:Developer/FS/SelfService|FS::SelfService API]] | ||
| + | |||
| + | = Reseller Documentation = | ||
| + | [[Freeside:1.9:Documentation:Developer:SelfService:Reseller|Reseller]] | ||
= Language Specific Documentation = | = Language Specific Documentation = | ||
| Line 23: | Line 27: | ||
* [[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/php_examples|PHP Examples]] (including a simple renewal app) | * [[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)
