projects
/
freeside.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
e9e20fd
)
update self-service login docs, RT#33628
author
Ivan Kohler
<ivan@freeside.biz>
Mon, 23 Feb 2015 01:11:03 +0000
(17:11 -0800)
committer
Ivan Kohler
<ivan@freeside.biz>
Mon, 23 Feb 2015 01:11:03 +0000
(17:11 -0800)
fs_selfservice/FS-SelfService/SelfService.pm
patch
|
blob
|
history
diff --git
a/fs_selfservice/FS-SelfService/SelfService.pm
b/fs_selfservice/FS-SelfService/SelfService.pm
index
adbf32f
..
6301b65
100644
(file)
--- a/
fs_selfservice/FS-SelfService/SelfService.pm
+++ b/
fs_selfservice/FS-SelfService/SelfService.pm
@@
-201,17
+201,43
@@
FS::SelfService - Freeside self-service API
# "my account" functionality
use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
# "my account" functionality
use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
+ #new-style login with an email address and password
+ # can also be used for svc_acct login, set $emailaddress to username@domain
+ my $rv = login ( { 'email' => $emailaddress,
+ 'password' => $password,
+ },
+ );
+ if ( $rv->{'error'} ) {
+ #handle login error...
+ } else {
+ #successful login
+ $session_id = $rv->{'session_id'};
+ }
+
+ #classic svc_acct-based login with separate username and password
my $rv = login( { 'username' => $username,
'domain' => $domain,
'password' => $password,
}
);
my $rv = login( { 'username' => $username,
'domain' => $domain,
'password' => $password,
}
);
+ if ( $rv->{'error'} ) {
+ #handle login error...
+ } else {
+ #successful login
+ $session_id = $rv->{'session_id'};
+ }
+ #svc_phone login with phone number and PIN
+ my $rv = login( { 'username' => $phone_number,
+ 'domain' => 'svc_phone',
+ 'password' => $pin,
+ }
+ );
if ( $rv->{'error'} ) {
#handle login error...
} else {
#successful login
if ( $rv->{'error'} ) {
#handle login error...
} else {
#successful login
-
my
$session_id = $rv->{'session_id'};
+ $session_id = $rv->{'session_id'};
}
my $customer_info = customer_info( { 'session_id' => $session_id } );
}
my $customer_info = customer_info( { 'session_id' => $session_id } );
@@
-308,6
+334,11
@@
following keys:
=over 4
=over 4
+=item email
+
+Email address (username@domain), instead of username and domain. Required for
+contact-based self-service login, can also be used for svc_acct-based login.
+
=item username
Username
=item username
Username