Operating WebMoney Keeper via WebMoney Keeper Pluggable Protocol (WMK)

This interface allows you to send various commands to WM Keeper Classic, for example: refresh data, open a window, send a message, etc.

This protocol syntax is similar to "mailto:" syntax.
For example, you can place the following link on your webpage: "Send me a message via WM Keeper"
Its code will look as follows:

WMK protocol commands have the following format:
wmk:<command>[?][parameter_1=value]&[parameter_2=value]&...[parameter_N=value]

There are parameters common for all wmk commands:

Name	Values	Description
WMID	WM-ID; 12 digits	This command will be executed only by the defined WM-ID (if several WM-IDs are launched) If this parameter was not defined, the command will be processed by all launched WM-IDs.
BringToFront	Y or N	Y displays WebMoney Keeper window on top of other windows
ExecEvenKeeperIsOffline	Y or N	By default, WMK commands are executed in the Online mode. Y allows to execute WMK commands when WM Keeper is offline.

If WebMoney Keeper is not running, it will be launched automatically.


Refresh
PayTo
MsgTo
Display
Explore
Exit

The command is used to refresh data. It duplicates the menu item: Menu| Refresh.

Parameters
No special parameters are used.

Sample
Let's assume that an invoice has been issued on your website. If wish your customer to be notified of it as soon as possible, you can either place the following link: Show new invoices or autosubmit the form.


[listing of commands]

The PayTo command displays a standard transaction dialog ("Sending WM-units"). Its parameters let set the purse where funds will be sent to, amount and transfer purpose (description).

Parameters

• Purse: Purse number;
• Amount: Amount;
• Desc: Transfer purpose (description).

Sample
The link below will allow your customers to Pay 100 WMZ to your purse.


[listing of commands]

The MsgTo command opens a standard message dialog ("A new message"). The parameters allow setting recipient's WM-ID, subject and message text.

Parameters

• To: Recipient's WM-ID;
• Subject: Subject of your message;
• Msg: Message text.

Sample
Send me a message via WM Keeper


[listing of commands]

The Display command displays the window defined in the Window parameter. This command also allows passing the initiating data in the Param parameter.

Parameters

• Window: name of the window that will be displayed.
  Parameter may have the following values:
  • Main: WebMoney Keeper Classic main menu;
  • Options: "Options" tab;
  • Props: "User details" section or "About me" tab depending on the Param parameter;
  • About: "About software" dialog;
  • Messages: "History of all messages";
  • Invoices_Out: Outgoing invoices listing
  • Invoices_In: Incoming invoices;
  • Operations: History of transactions.
• Page: Dialog page (1 - first, 2-second, etc) that will be displayed. This parameter is used for Main, Options and Props.
• Param is used by Props. It is used to pass WM-ID of the user whose information will be displayed in the "User details" dialog. If this parameter is not used, the "About me" tab will be displayed.

Sample
Display purse listing
Click here to learn what version of WebMoney Keeper you are using
Edit your personal data
Change skin


[listing of commands]

The Explore command displays a webpage defined in the URL parameter in a special WebMoney Keeper window.

Parameters

• URL: a page to display;
• Title: title of the window this page will be displayed in.

Sample
Click Me :)


[listing of commands]

The Exit command offers a user to exit WebMoney Keeper.

Parameters
No special parameters are used.

Sample
Exit WebMoney Keeper


[listing of commands]