Freeside:3:Documentation:Developer:SelfService

From Freeside
Revision as of 13:10, 5 February 2014 by Ivan (talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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

FS::SelfService API

Reseller Documentation

Reseller

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