4 use FS::Record qw( qsearchs );
9 FS::API - Freeside backend API
17 This module implements a backend API for advanced back-office integration.
19 In contrast to the self-service API, which authenticates an end-user and offers
20 functionality to that end user, the backend API performs a simple shared-secret
21 authentication and offers full, administrator functionality, enabling
22 integration with other back-office systems.
24 If accessing this API remotely with XML-RPC or JSON-RPC, be careful to block
25 the port by default, only allow access from back-office servers with the same
26 security precations as the Freeside server, and encrypt the communication
27 channel (for exampple, with an SSH tunnel or VPN) rather than accessing it
34 # needs to be able to:
39 # would like to be able to pass the phone number ( from svc_phone ) to the API for this query.
43 #generally, the more useful data from the cust_main record the better.
46 # "2 way syncing" ? start with non-sync pulling info here, then if necessary
47 # figure out how to trigger something when those things change
49 # long-term: package changes?
55 #some false laziness w/ClientAPI::Myaccount customer_info/customer_info_short
57 use vars qw( @cust_main_editable_fields @location_editable_fields );
58 @cust_main_editable_fields = qw(
59 first last company daytime night fax mobile
62 # payby payinfo payname paystart_month paystart_year payissue payip
63 # ss paytype paystate stateid stateid_state
64 @location_editable_fields = qw(
65 address1 address2 city county state zip country
69 my( $class, %opt ) = @_;
70 my $conf = new FS::Conf;
71 return { 'error' => 'Incorrect shared secret' }
72 unless $opt{secret} eq $conf->config('api_shared_secret');
74 my $cust_main = qsearchs('cust_main', { 'custnum' => $opt{custnum} })
75 or return { 'error' => 'Unknown custnum' };
79 'display_custnum' => $cust_main->display_custnum,
80 'name' => $cust_main->first. ' '. $cust_main->get('last'),
81 'balance' => $cust_main->balance,
82 'status' => $cust_main->status,
83 'statuscolor' => $cust_main->statuscolor,
86 $return{$_} = $cust_main->get($_)
87 foreach ( @cust_main_editable_fields,
88 @location_editable_fields,
89 map "ship_$_", @location_editable_fields,
92 my @invoicing_list = $cust_main->invoicing_list;
93 $return{'invoicing_list'} =
94 join(', ', grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list );
95 $return{'postal_invoicing'} =
96 0 < ( grep { $_ eq 'POST' } @invoicing_list );
102 #I also monitor for changes to the additional locations that are applied to
103 # packages, and would like for those to be exportable as well. basically the
104 # location data passed with the custnum.
106 my( $class, %opt ) = @_;
107 my $conf = new FS::Conf;
108 return { 'error' => 'Incorrect shared secret' }
109 unless $opt{secret} eq $conf->config('api_shared_secret');
111 my @cust_location = qsearch('cust_location', { 'custnum' => $opt{custnum} });
115 'locations' => [ @cust_location ],
121 #Advertising sources?