|
|
|
|
Notes:
The session_close function usage is not necessary but recommended.
Namespace must be followed by API version number, e.g. HSPC/API/1.0
Session ID returned by session_open must be included in HTTP Headers or SOAP Headers for all the other methods called in the frame of each session.
Common SOAP Faults codes:
UserError |
Mandatory parameter missing from SOAP method call |
WrongParams |
Invalid method parameters |
session_open
The function opens session with Parallels Business Automation - Standard XML API server. The input parameters composition depends on the store installation: (local, i.e. Store is installed on the sane server as Parallels Business Automation - Standard or remote, i.e., the Store installed on a remote server).
Parameters:
account_id |
ID of a vendor account a session is to be opened for. This parameter is to be passed in case of a local Store installation. Optional parameter in case |
server_name |
Vendor server name used for authentication. This parameter is to be passed in case of a local Store installation. Optional parameter in case |
Registered person e-mail. Parameter is to be specified in case of the Store remote installation together with the |
|
password |
Registered person password. Parameter is to be specified in case of the Store remote installation together with the email parameter. |
Returns: {
account_id =>
session_id => }
Parameter |
Means |
account_id |
The numerical identifier of an account a session has been opened for. Account ID is returned in any case, a vendor account ID is then used by the other Store API functions. |
session_id |
The identifier of the opened session. |
SOAP Faults codes:
No specific codes.
session_close
The function closes session.
No parameters.
No return value.
No specific codes.