Skip to content

API Auth

Compatibility

  • EE2
  • EE3
  • EE4
  • EE5
  • EE6
  • EE7

Installation

The Auth API comes natively with Webservice module.

Methods

authenticate

Short nameDescription
usernameYour usernameRequired
passwordYour passwordRequired
new_sessionCreate a new sessionOptional

Request

$client = new SoapClient('your-domain.com/index.php/webservice/soap?wsdl', array('trace' => 1));

$session_data = $client->authenticate_username('testUsername', 'testPassword');

print_r($session_data);

Request (new session)

$client = new SoapClient('your-domain.com/index.php/webservice/soap?wsdl', array('trace' => 1));

$session_data = $client->authenticate_username('testUsername', 'testPassword', 'yes');

print_r($session_data);

authenticate_username

This is an alias for authenticate