Child pages
  • UAPI Functions - Market::get_login_url

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt
This function retrieves the login URL for the cPanel Market provider.

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titlecPanel or Webmail Session URL
Code Block
languagetext
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

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Retrieve login URL for the cPanel Market provider.
$retrieve_url = $cpanel->uapi(
    'Market', 'get_login_url',
    array(
        'provider'         => 'cPStore',
        'url_after_login'  => 'http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate',
    )
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Retrieve login URL for the cPanel Market provider.
my $retrieve_url = $cpliveapi->uapi(
    'Market', 'get_login_url',
    {
        'provider'        => 'cPStore',
        'url_after_login' => 'http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Template Toolkit
Code Block
languagexml
linenumberstrue
<!-- Retrieve login URL for the cPanel Market provider. -->
[% execute('Market', 'get_login_url', { provider => 'cPStore', url_after_login =>  'http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate'} ) %]

Include Page
LIB:_TTLink
LIB:_TTLink

 

Expand
titleCommand Line
Code Block
languagebash
uapi --user=username Market get_login_url provider=cPStore url_after_login=http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{  
   "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"
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

   

Parameters

ParameterTypeDescriptionPossible valuesExample
providerstring

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

ReturnTypeDescriptionPossible valuesExample
datastring

The URL to which to redirect the browser after login.

A valid URL.
Expand
titleClick to view...

https://10.17.2.12/api/?client_id=MyHearseIsAmazing&function=login&module=bogoSSL&redirect_uri=https%3A%2F%2Fqaportal.cpanel.net%2Fbogus.cgi&response_type=token