4 use FS::Record qw( qsearch qsearchs );
13 FS::API - Freeside backend API
21 This module implements a backend API for advanced back-office integration.
23 In contrast to the self-service API, which authenticates an end-user and offers
24 functionality to that end user, the backend API performs a simple shared-secret
25 authentication and offers full, administrator functionality, enabling
26 integration with other back-office systems.
28 If accessing this API remotely with XML-RPC or JSON-RPC, be careful to block
29 the port by default, only allow access from back-office servers with the same
30 security precations as the Freeside server, and encrypt the communication
31 channel (for exampple, with an SSH tunnel or VPN) rather than accessing it
42 my $result = FS::API->insert_payment(
43 'secret' => 'sharingiscaring',
49 '_date' => 1397977200, #UNIX timestamp
52 if ( $result->{'error'} ) {
53 die $result->{'error'};
56 print "paynum ". $result->{'paynum'};
63 my($class, %opt) = @_;
64 my $conf = new FS::Conf;
65 return { 'error' => 'Incorrect shared secret' }
66 unless $opt{secret} eq $conf->config('api_shared_secret');
68 #less "raw" than this? we are the backoffice API, and aren't worried
69 # about version migration ala cust_main/cust_location here
70 my $cust_pay = new FS::cust_pay { %opt };
71 my $error = $cust_pay->insert( 'manual'=>1 );
72 return { 'error' => $error,
73 'paynum' => $cust_pay->paynum,
77 # pass the phone number ( from svc_phone )
78 sub insert_payment_phonenum {
79 my($class, %opt) = @_;
80 my $conf = new FS::Conf;
81 return { 'error' => 'Incorrect shared secret' }
82 unless $opt{secret} eq $conf->config('api_shared_secret');
84 $class->_by_phonenum('insert_payment', %opt);
89 my($class, $method, %opt) = @_;
90 my $conf = new FS::Conf;
91 return { 'error' => 'Incorrect shared secret' }
92 unless $opt{secret} eq $conf->config('api_shared_secret');
94 my $phonenum = delete $opt{'phonenum'};
96 my $svc_phone = qsearchs('svc_phone', { 'phonenum' => $phonenum } )
97 or return { 'error' => 'Unknown phonenum' };
99 my $cust_pkg = $svc_phone->cust_svc->cust_pkg
100 or return { 'error' => 'Unlinked phonenum' };
102 $opt{'custnum'} = $cust_pkg->custnum;
104 $class->$method(%opt);
112 my $result = FS::API->insert_credit(
113 'secret' => 'sharingiscaring',
118 '_date' => 1397977200, #UNIX timestamp
121 if ( $result->{'error'} ) {
122 die $result->{'error'};
125 print "crednum ". $result->{'crednum'};
132 my($class, %opt) = @_;
133 my $conf = new FS::Conf;
134 return { 'error' => 'Incorrect shared secret' }
135 unless $opt{secret} eq $conf->config('api_shared_secret');
137 $opt{'reasonnum'} ||= $conf->config('api_credit_reason');
139 #less "raw" than this? we are the backoffice API, and aren't worried
140 # about version migration ala cust_main/cust_location here
141 my $cust_credit = new FS::cust_credit { %opt };
142 my $error = $cust_credit->insert;
143 return { 'error' => $error,
144 'crednum' => $cust_credit->crednum,
148 # pass the phone number ( from svc_phone )
149 sub insert_credit_phonenum {
150 my($class, %opt) = @_;
151 my $conf = new FS::Conf;
152 return { 'error' => 'Incorrect shared secret' }
153 unless $opt{secret} eq $conf->config('api_shared_secret');
155 $class->_by_phonenum('insert_credit', %opt);
163 my $result = FS::API->insert_refund(
164 'secret' => 'sharingiscaring',
170 '_date' => 1397977200, #UNIX timestamp
173 if ( $result->{'error'} ) {
174 die $result->{'error'};
177 print "refundnum ". $result->{'crednum'};
184 my($class, %opt) = @_;
185 my $conf = new FS::Conf;
186 return { 'error' => 'Incorrect shared secret' }
187 unless $opt{secret} eq $conf->config('api_shared_secret');
189 # when github pull request #24 is merged,
190 # will have to change over to default reasonnum like credit
191 # but until then, this will do
192 $opt{'reason'} ||= 'API refund';
194 #less "raw" than this? we are the backoffice API, and aren't worried
195 # about version migration ala cust_main/cust_location here
196 my $cust_refund = new FS::cust_refund { %opt };
197 my $error = $cust_refund->insert;
198 return { 'error' => $error,
199 'refundnum' => $cust_refund->refundnum,
203 # pass the phone number ( from svc_phone )
204 sub insert_refund_phonenum {
205 my($class, %opt) = @_;
206 my $conf = new FS::Conf;
207 return { 'error' => 'Incorrect shared secret' }
208 unless $opt{secret} eq $conf->config('api_shared_secret');
210 $class->_by_phonenum('insert_refund', %opt);
216 #generally, the more useful data from the cust_main record the better.
219 # "2 way syncing" ? start with non-sync pulling info here, then if necessary
220 # figure out how to trigger something when those things change
222 # long-term: package changes?
228 #some false laziness w/ClientAPI::Myaccount customer_info/customer_info_short
230 use vars qw( @cust_main_editable_fields @location_editable_fields );
231 @cust_main_editable_fields = qw(
232 first last company daytime night fax mobile
235 # payby payinfo payname paystart_month paystart_year payissue payip
236 # ss paytype paystate stateid stateid_state
237 @location_editable_fields = qw(
238 address1 address2 city county state zip country
242 my( $class, %opt ) = @_;
243 my $conf = new FS::Conf;
244 return { 'error' => 'Incorrect shared secret' }
245 unless $opt{secret} eq $conf->config('api_shared_secret');
247 my $cust_main = qsearchs('cust_main', { 'custnum' => $opt{custnum} })
248 or return { 'error' => 'Unknown custnum' };
252 'display_custnum' => $cust_main->display_custnum,
253 'name' => $cust_main->first. ' '. $cust_main->get('last'),
254 'balance' => $cust_main->balance,
255 'status' => $cust_main->status,
256 'statuscolor' => $cust_main->statuscolor,
259 $return{$_} = $cust_main->get($_)
260 foreach @cust_main_editable_fields;
262 for (@location_editable_fields) {
263 $return{$_} = $cust_main->bill_location->get($_)
264 if $cust_main->bill_locationnum;
265 $return{'ship_'.$_} = $cust_main->ship_location->get($_)
266 if $cust_main->ship_locationnum;
269 my @invoicing_list = $cust_main->invoicing_list;
270 $return{'invoicing_list'} =
271 join(', ', grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list );
272 $return{'postal_invoicing'} =
273 0 < ( grep { $_ eq 'POST' } @invoicing_list );
279 #I also monitor for changes to the additional locations that are applied to
280 # packages, and would like for those to be exportable as well. basically the
281 # location data passed with the custnum.
283 my( $class, %opt ) = @_;
284 my $conf = new FS::Conf;
285 return { 'error' => 'Incorrect shared secret' }
286 unless $opt{secret} eq $conf->config('api_shared_secret');
288 my @cust_location = qsearch('cust_location', { 'custnum' => $opt{custnum} });
292 'locations' => [ @cust_location ],
298 #Advertising sources?