Description
This function retrieves the login URL for the cPanel Market provider.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Market/get_login_url?provider=cPStore&url_after_login=http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate
LiveAPI PHP Class
$cpanel = new CPANEL();
$retrieve_url = $cpanel->uapi(
'Market', 'get_login_url',
array(
'provider' => 'cPStore',
'url_after_login' => 'http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $retrieve_url = $cpliveapi->uapi(
'Market', 'get_login_url',
{
'provider' => 'cPStore',
'url_after_login' => 'http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate',
}
);
cPanel Template Toolkit
[% execute('Market', 'get_login_url', { provider => 'cPStore', url_after_login => 'http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate'} ) %]
Command Line
uapi --user=username Market get_login_url provider=cPStore url_after_login=http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate
|
Output (JSON)
{
"messages":null,
"errors":null,
"status":1,
"metadata":{
"transformed":1
},
"data": "https://192.168.0.1/api/?client_id=MyHearseIsAmazing&function=login&module=bogoSSL&redirect_uri=https%3A%2F%2Fqaportal.cpanel.net%2Fbogus.cgi&response_type=token"
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
provider
|
string
|
Required
The cPanel Market provider's name.
|
Any valid provider name.
|
cPStore
|
|
url_after_login
|
string
|
Required
Where the cPanel Market provider redirects the user's browser after they log in.
|
Any valid URL that includes a query component.
|
http://hostname.example.com/redirectionlocation.cgi?state
|
Return
|
Return
|
Type
|
Description
|
Possible values
|
|
data
|
string
|
The URL to which to redirect the browser after login.
|
A valid URL.
|
