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

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
Line 1: Line 1:
 
==NAME==
 
==NAME==
FS::API - API for advanced back-office integration
+
FS::API - Freeside backend API
  
 
==SYNOPSIS==
 
==SYNOPSIS==
 +
<code>
 +
  use FS::API;
 +
</code>
 +
==DESCRIPTION==
 +
This module implements a backend API for advanced back-office integration.
  
<pre>
+
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.
  
use strict;
+
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.
use Frontier::Client;
 
use Data::Dumper;
 
  
my $uri = new URI 'http://localhost:8008/';
+
==METHODS==
 +
; insert_payment
 +
:Adds a new payment to a customers account. Takes a hash reference as parameter with the following keys:
 +
:; secret
 +
::API Secret
 +
:; custnum
 +
::Customer number
 +
:; payby
 +
::Payment type
 +
:; paid
 +
::Amount paid
 +
:; _date
 +
::Option date for payment
  
my $server = new Frontier::Client ( 'url' => $uri );
+
::Example:
 +
<code>
 +
  my $result = FS::API->insert_payment(
 +
    'secret'  => 'sharingiscaring',
 +
    'custnum' => 181318,
 +
    'payby'   => 'CASH',
 +
    'paid'    => '54.32',
 +
 +
    #optional
 +
    '_date'  => 1397977200, #UNIX timestamp
 +
  );
 +
 +
  if ( $result->{'error'} ) {
 +
    die $result->{'error'};
 +
  } else {
 +
    #payment was inserted
 +
    print "paynum ". $result->{'paynum'};
 +
  }
 +
</code>
 +
; insert_credit
 +
:Adds a a credit to a customers account. Takes a hash reference as parameter with the following keys
 +
:; secret
 +
::API Secret
 +
:; custnum
 +
::customer number
 +
:; amount
 +
::Amount of the credit
 +
:; _date
 +
::The date the credit will be posted
  
my $result = $server->call(
+
::Example:
  'FS.API.customer_info',
+
<code>
 +
  my $result = FS::API->insert_credit(
 
     'secret'  => 'sharingiscaring',
 
     'secret'  => 'sharingiscaring',
 
     'custnum' => 181318,
 
     'custnum' => 181318,
);
+
    'amount'  => '54.32',
 +
 +
    #optional
 +
    '_date'  => 1397977200, #UNIX timestamp
 +
  );
 +
 +
  if ( $result->{'error'} ) {
 +
    die $result->{'error'};
 +
  } else {
 +
    #credit was inserted
 +
    print "crednum ". $result->{'crednum'};
 +
  }
 +
</code>
 +
; insert_refund
 +
:Adds a a credit to a customers account. Takes a hash reference as parameter with the following keys: custnum,payby,refund
  
#die $result->{'error'} if $result->{'error'};
+
:Example:
 
+
<code>
print Dumper($result);
+
  my $result = FS::API->insert_refund(
 
+
    'secret' => 'sharingiscaring',
1;
+
    'custnum' => 181318,
</pre>
+
    'payby'  => 'CASH',
 
+
    'refund'  => '54.32',
==DESCRIPTION==
+
This module implements a backend API for advanced back-office integration.
+
    #optional
 
+
    '_date'  => 1397977200, #UNIX timestamp
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
+
  if ( $result->{'error'} ) {
integration with other back-office systems.
+
    die $result->{'error'};
 
+
  } else {
If accessing this API remotely with XML-RPC or JSON-RPC, be careful to block
+
    #refund was inserted
the port by default, only allow access from back-office servers with the same
+
    print "refundnum ". $result->{'crednum'};
security precations as the Freeside server, and encrypt the communication
+
  }
channel (for exampple, with an SSH tunnel or VPN) rather than accessing it
+
</code>
in plaintext.
+
; new_customer
 
 
==METHODS==
 
'''customer_info''' HASHREF<br>
 
Returns general customer information.
 
Takes a hash reference as parameter with the following keys, custnum and API secret
 
<br><br>
 
'''location_info''' HASHREF<br>
 
Returns location specific information for the customer.
 
Takes a hash reference as parameter with the following keys, custnum and API secret
 
<br><br>
 
'''new_customer''' HASHREF<br>
 
 
:Creates a new customer. Takes a hash reference as parameter with the following keys:
 
:Creates a new customer. Takes a hash reference as parameter with the following keys:
 
:; secret
 
:; secret
Line 75: Line 122:
 
::2 Digit Country Code
 
::2 Digit Country Code
 
:; latitude
 
:; latitude
::Latitude
+
::latitude
:; longitude
+
:; Longitude
::Longitude
+
::longitude
 
:; geocode
 
:; geocode
 
::Currently used for third party tax vendor lookups
 
::Currently used for third party tax vendor lookups
Line 83: Line 130:
 
::Used for determining FCC 477 reporting
 
::Used for determining FCC 477 reporting
 
:; censusyear
 
:; censusyear
::Used for determining FCC 477 reporting  
+
::Used for determining FCC 477 reporting
 
:; daytime
 
:; daytime
 
::Daytime phone number
 
::Daytime phone number
Line 92: Line 139:
 
:; mobile
 
:; mobile
 
::Mobile number
 
::Mobile number
 
 
:; invoicing_list
 
:; invoicing_list
::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),
+
::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), postal_invoicing Set to 1 to enable postal invoicing
:; postal_invoicing
 
:: Set to 1 to enable postal invoicing
 
 
:; payby
 
:; payby
 
::CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY
 
::CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY
Line 114: Line 158:
 
::Agent specific customer number
 
::Agent specific customer number
 
:; referral_custnum
 
:; referral_custnum
:: Referring customer number
+
::Referring customer number
<br><br>
+
; customer_info
'''insert_payment'''<br>
+
:Returns general customer information. Takes a hash reference as parameter with the following keys: custnum and API secret
Adds a new payment to a customers account. Takes a hash reference as parameter with the following keys:
+
; location_info
:; secret
+
:Returns location specific information for the customer. Takes a hash reference as parameter with the following keys: custnum,secret
::API Secret
 
:; custnum
 
::Customer number
 
:; payby
 
::Payment type
 
:; paid
 
::Amount paid
 
<br>
 
== Bugs ==
 

Revision as of 13:31, 27 June 2014

NAME

FS::API - Freeside backend API

SYNOPSIS

 use FS::API;

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

insert_payment
Adds a new payment to a customers account. Takes a hash reference as parameter with the following keys:
secret
API Secret
custnum
Customer number
payby
Payment type
paid
Amount paid
_date
Option date for payment
Example:

 my $result = FS::API->insert_payment(
   'secret'  => 'sharingiscaring',
   'custnum' => 181318,
   'payby'   => 'CASH',
   'paid'    => '54.32',

   #optional
   '_date'   => 1397977200, #UNIX timestamp
 );

 if ( $result->{'error'} ) {
   die $result->{'error'};
 } else {
   #payment was inserted
   print "paynum ". $result->{'paynum'};
 }

insert_credit
Adds a a credit to a customers account. Takes a hash reference as parameter with the following keys
secret
API Secret
custnum
customer number
amount
Amount of the credit
_date
The date the credit will be posted
Example:

 my $result = FS::API->insert_credit(
   'secret'  => 'sharingiscaring',
   'custnum' => 181318,
   'amount'  => '54.32',

   #optional
   '_date'   => 1397977200, #UNIX timestamp
 );

 if ( $result->{'error'} ) {
   die $result->{'error'};
 } else {
   #credit was inserted
   print "crednum ". $result->{'crednum'};
 }

insert_refund
Adds a a credit to a customers account. Takes a hash reference as parameter with the following keys: custnum,payby,refund
Example:

 my $result = FS::API->insert_refund(
   'secret'  => 'sharingiscaring',
   'custnum' => 181318,
   'payby'   => 'CASH',
   'refund'  => '54.32',

   #optional
   '_date'   => 1397977200, #UNIX timestamp
 );

 if ( $result->{'error'} ) {
   die $result->{'error'};
 } else {
   #refund was inserted
   print "refundnum ". $result->{'crednum'};
 }

new_customer
Creates a new customer. Takes a hash reference as parameter with the following keys:
secret
API Secret
first
first name (required)
last
last name (required)
ss
(not typically collected; mostly used for ACH transactions)
company
Company name
address1 (required)
Address line one
city (required)
City
county
County
state (required)
State
zip (required)
Zip or postal code
country
2 Digit Country Code
latitude
latitude
Longitude
longitude
geocode
Currently used for third party tax vendor lookups
censustract
Used for determining FCC 477 reporting
censusyear
Used for determining FCC 477 reporting
daytime
Daytime phone number
night
Evening phone number
fax
Fax number
mobile
Mobile number
invoicing_list
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), postal_invoicing Set to 1 to enable postal invoicing
payby
CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY
payinfo
Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
paycvv
Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
paydate
Expiration date for CARD/DCRD
payname
Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
referral_custnum
referring customer number
agentnum
Agent number
agent_custid
Agent specific customer number
referral_custnum
Referring customer number
customer_info
Returns general customer information. Takes a hash reference as parameter with the following keys: custnum and API secret
location_info
Returns location specific information for the customer. Takes a hash reference as parameter with the following keys: custnum,secret