Session
OpenSession [finished]
Overlays:
Activation:
OpenSession.php
Description:
Opens a session and assigns an ID to it.
Note that this function requires using HTTP POST method and passing parameters in POST request body. login and passwd parameters are required.
Parameters:
- login: string(64)
- passwd: string(100)
Results:
<OpenSession>
<status>OK</status>
<sessionID>686b2c505c7b642c</sessionID> : string(16)
</OpenSession>
Throw Errors:
SendPasswordRecoveryToken [finished]
Overlays:
Activation:
SendPasswordRecoveryToken.php ? login = ... & email = ...
Description:
Sends a request for email with password recovery link.
Parameters:
- login: string(64)
- email: string(255)
Results:
<SendPasswordRecoveryToken>
<status>OK</status>
</SendPasswordRecoveryToken>
Throw Errors:
ChangePasswordByToken [finished]
Overlays:
Activation:
ChangePasswordByToken.php
Description:
Sets user password with an authorization of password recovery token.
Note that this function requires using HTTP POST method and passing parameters in POST request body. passwd and token parametrs are required.
Parameters:
- passwd: string(100)
- token: string(64)
Results:
<ChangePasswordByToken>
<status>OK</status>
</ChangePasswordByToken>
Throw Errors:
Ping [finished]
Overlays:
Activation:
Ping.php ?
[ sessionID = ... ]
Description:
Parameters:
- sessionID: string(16)
Results:
<Ping>
<status>OK</status>
</Ping>
Throw Errors:
CloseSession [finished]
Overlays:
Activation:
CloseSession.php ? sessionID = ...
Description:
Closes a session.
Parameters:
- sessionID: string(16)
Results:
<CloseSession>
<status>OK</status>
</CloseSession>
Throw Errors:
GetApiVersion [finished]
Overlays:
Activation:
GetApiVersion.php ?
Description:
Returns the version number of API
Parameters:
Results:
<GetApiVersion>
<status>OK</status>
<version>42</version> : string(16)
</GetApiVersion>