Child pages
  • UAPI Functions - Market::get_login_url
Skip to end of metadata
Go to start of metadata

 

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


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$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',
    )
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
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',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Template Toolkit
<!-- 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'} ) %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 

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


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 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"
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

   

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.
 Click 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