add_session()

Create a session token.

All API functions Sessions

Signature

add_session(array $parameters): mixed

Parameters

Pass these parameters as KasRequestParams. Every request also requires kas_login, kas_auth_type, and kas_auth_data, as shown in SOAP with PHP.

Name Description Requirement
session_lifetime The session lifetime in seconds: 1-30000 Required
session_update_lifetime Extend the session whenever it is used: Y|N Required
session_2fa The one-time PIN (optional, required if two-factor authentication is enabled) Optional

PHP example

<?php

// $sessionToken is returned by KasAuth, see SOAP with PHP.
$parameters = [
    'session_lifetime' => '500',
    'session_update_lifetime' => 'Y',
];

try {
    $client = new SoapClient('https://kasapi.kasserver.com/soap/wsdl/KasApi.wsdl');
    $response = $client->KasApi(json_encode([
        'kas_login' => 'w0123456',
        'kas_auth_type' => 'session',
        'kas_auth_data' => $sessionToken,
        'kas_action' => 'add_session',
        'KasRequestParams' => $parameters,
    ]));
    print_r($response);
} catch (SoapFault $fault) {
    echo 'Error: ' . $fault->faultstring;
}
Open interactive example

Responses and error codes

  • TRUE the action was carried out
  • missing_parameter a required parameter is missing
  • session_lifetime_syntax_incorrect
  • session_update_lifetime_syntax_incorrect