Session
OpenSession [finished]
Nakładki:
Wywołanie:
OpenSession.php
Opis:
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.
Parametry:
- login: string(64)
- passwd: string(100)
Wynik:
<OpenSession>
<status>OK</status>
<sessionID>686b2c505c7b642c</sessionID> : string(16)
</OpenSession>
Zwracane błędy:
SendPasswordRecoveryToken [finished]
Nakładki:
Wywołanie:
SendPasswordRecoveryToken.php ? login = ... & email = ...
Opis:
Sends a request for email with password recovery link.
Parametry:
- login: string(64)
- email: string(255)
Wynik:
<SendPasswordRecoveryToken>
<status>OK</status>
</SendPasswordRecoveryToken>
Zwracane błędy:
ChangePasswordByToken [finished]
Nakładki:
Wywołanie:
ChangePasswordByToken.php
Opis:
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.
Parametry:
- passwd: string(100)
- token: string(64)
Wynik:
<ChangePasswordByToken>
<status>OK</status>
</ChangePasswordByToken>
Zwracane błędy:
Ping [finished]
Nakładki:
Wywołanie:
Ping.php ?
[ sessionID = ... ]
Opis:
Parametry:
- sessionID: string(16)
Wynik:
<Ping>
<status>OK</status>
</Ping>
Zwracane błędy:
CloseSession [finished]
Nakładki:
Wywołanie:
CloseSession.php ? sessionID = ...
Opis:
Closes a session.
Parametry:
- sessionID: string(16)
Wynik:
<CloseSession>
<status>OK</status>
</CloseSession>
Zwracane błędy:
GetApiVersion [finished]
Nakładki:
Wywołanie:
GetApiVersion.php ?
Opis:
Returns the version number of API
Parametry:
Wynik:
<GetApiVersion>
<status>OK</status>
<version>42</version> : string(16)
</GetApiVersion>