Difference between revisions of "Freeside:3:Documentation:Developer/FS/API"

Revision as of 09:04, 31 March 2014

NAME

FS::API - API for advanced back-office integration

SYNOPSIS

use strict;
use Frontier::Client;
use Data::Dumper;

my $uri = new URI 'http://localhost:8008/';

my $server = new Frontier::Client ( 'url' => $uri );

my $result = $server->call(
  'FS.API.customer_info',
    'secret'  => 'sharingiscaring',
    'custnum' => 181318,
);

#die $result->{'error'} if $result->{'error'};

print Dumper($result);

1;

DESCRIPTION

This module implements a backend API for advanced back-office integration.

In contrast to the self-service API, which authenticates an end-user and offers functionality to that end user, the backend API performs a simple shared-secret authentication and offers full, administrator functionality, enabling integration with other back-office systems.

If accessing this API remotely with XML-RPC or JSON-RPC, be careful to block the port by default, only allow access from back-office servers with the same security precations as the Freeside server, and encrypt the communication channel (for exampple, with an SSH tunnel or VPN) rather than accessing it in plaintext.

METHODS

customer_info new_customer insert_payment insert_credit insert_refund