X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2FAPI.pm;h=1e960c8d18804793f8debc01acf3e495922cbc5f;hb=ab9aa5b5d55eb7330b3435819663ef03538278e2;hp=400da14221fac5522df15101bfb7881b4c86c3f4;hpb=832199a6010883fff76e0dc5fa913b391b0177d7;p=freeside.git diff --git a/FS/FS/API.pm b/FS/FS/API.pm index 400da1422..1e960c8d1 100644 --- a/FS/FS/API.pm +++ b/FS/FS/API.pm @@ -23,7 +23,9 @@ 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. +integration with other back-office systems. Only access this API from a secure +network from other backoffice machines. DON'T use this API to create customer +portal functionality. 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 @@ -478,9 +480,11 @@ sub new_customer { } =item update_customer -Updates an existing customer. Passing an empty value clears that field, while NOT passing that key/value at all leaves it alone. -Takes a hash reference as parameter with the following keys: +Updates an existing customer. Passing an empty value clears that field, while +NOT passing that key/value at all leaves it alone. Takes a list of keys and +values as parameters with the following keys: + =over 4 =item secret @@ -545,9 +549,9 @@ Mobile number =item invoicing_list -comma-separated list of email addresses for email invoices. The special value '$ -postal_invoicing -Set to 1 to enable postal invoicing +Comma-separated list of email addresses for email invoices. The special value +'POST' is used to designate postal invoicing (it may be specified alone or in +addition to email addresses) =item payby @@ -555,7 +559,8 @@ CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY =item payinfo -Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pi$ +Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid ++"pin" for PREPAY, purchase order number for BILL =item paycvv @@ -590,6 +595,8 @@ sub update_customer { my( $class, %opt ) = @_; my $conf = new FS::Conf; + return { 'error' => 'Incorrect shared secret' } + unless $opt{secret} eq $conf->config('api_shared_secret'); my $custnum = $opt{'custnum'} @@ -608,10 +615,13 @@ sub update_customer { payby payinfo paydate paycvv payname ), - my @invoicing_list = $opt{'invoicing_list'} - ? split( /\s*\,\s*/, $opt{'invoicing_list'} ) - : $cust_main->invoicing_list; - push @invoicing_list, 'POST' if $opt{'postal_invoicing'}; + my @invoicing_list; + if ( exists $opt{'invoicing_list'} || exists $opt{'postal_invoicing'} ) { + @invoicing_list = split( /\s*\,\s*/, $opt{'invoicing_list'} ); + push @invoicing_list, 'POST' if $opt{'postal_invoicing'}; + } else { + @invoicing_list = $cust_main->invoicing_list; + } if ( exists( $opt{'address1'} ) ) { my $bill_location = FS::cust_location->new({ @@ -625,7 +635,7 @@ sub update_customer { $new->set('bill_location' => $bill_location); } - if ( exists($opt{'ship_address1'}) ) { + if ( exists($opt{'ship_address1'}) && length($opt{"ship_address1"}) > 0 ) { my $ship_location = FS::cust_location->new({ map { $_ => $opt{"ship_$_"} } @location_editable_fields }); @@ -634,16 +644,13 @@ sub update_customer { my $error = $ship_location->find_or_insert; die $error if $error; - } - - if ( !grep { length($opt{"ship_$_"}) } @location_editable_fields ) { - # Selfservice unfortunately tries to indicate "same as billing - # address" by sending all fields empty. Did this ever work? + $new->set('ship_location' => $ship_location); - my $ship_location = $cust_main->bill_location; - $new->set('ship_location' => $ship_location); + } elsif (exists($opt{'ship_address1'} ) && !grep { length($opt{"ship_$_"}) } @location_editable_fields ) { + my $ship_location = $new->bill_location; + $new->set('ship_location' => $ship_location); + } - } my $error = $new->replace( $cust_main, \@invoicing_list ); return { 'error' => $error } if $error; @@ -746,8 +753,21 @@ sub location_info { Bills a single customer now, in the same fashion as the "Bill now" link in the UI. -Returns a hash reference with a single key, 'error'. If there is an error, -the value contains the error, otherwise it is empty. +Returns a hash reference with a single key, 'error'. If there is an error, +the value contains the error, otherwise it is empty. Takes a list of keys and +values as parameters with the following keys: + +=over 4 + +=item secret + +API Secret (required) + +=item custnum + +Customer number (required) + +=back =cut