Parallels Parallels Business Automation Standard Software Development Kit Release 4.2. Revision 1.0 (c) 1999-2012 Copyright Notice Parallels IP Holdings, GmbH. c/o Parallels International GMbH. Parallels International GmbH Vordergasse 49 CH - 8200 Schaffhausen Switzerland Tel: + 49 (6151) 42996 - 0 Fax: + 49 (6151) 42996 - 255 Copyright © 1999-2012 Parallels IP Holdings GmbH. and its affiliates. All rights reserved. This product is protected by United States and international copyright laws. The product's underlying technology, patents, and trademarks are listed at http://www.parallels.com/trademarks Microsoft, Windows, Windows Server, Windows NT, Windows Vista, and MS-DOS are registered trademarks of Microsoft Corporation. Linux is a registered trademark of Linus Torvalds. Mac is a registered trademark of Apple, Inc. All other marks and names mentioned herein may be trademarks of their respective owners. Changes History Date Revision Changes Description June 19, 1012 1.0 CP Customization methods updated according to PBAS v.4.2. Contents Changes History 3 Preface 9 Typographical Conventions .......................................................................................................................... 9 Feedback ..................................................................................................................................................... 10 Shell Prompts in Command Examples........................................................................................................ 10 General Conventions................................................................................................................................... 11 XML API 12 Introduction to Parallels Business Automation - Standard XML API ........................................................ 13 HSPC/API ................................................................................................................................................... 18 session_open .................................................................................................................................... 18 session_close ................................................................................................................................... 19 HSPC/API/HP............................................................................................................................................. 20 check_app_compat .......................................................................................................................... 20 check_license_compat ..................................................................................................................... 21 get_categorized_plan_list ................................................................................................................ 22 get_extended_plan_info ................................................................................................................... 23 Example of EXTENDED_HP_INFO Hash .......................................................................... 24 get_full_extended_plan_info ........................................................................................................... 31 get_plan_promotion_list .................................................................................................................. 32 get_promotion.................................................................................................................................. 32 get_sellable_plan_list ...................................................................................................................... 33 validate_plesk_login ........................................................................................................................ 34 HSPC/API/Billing ....................................................................................................................................... 35 calculate_order ................................................................................................................................ 35 Examples of ORDER Hash .................................................................................................. 39 get_hosting_target_list..................................................................................................................... 49 place_order ...................................................................................................................................... 50 create_offline_payment ................................................................................................................... 56 Example of Test Code for create_offline_payment Function ............................................... 57 get_order_details ............................................................................................................................. 58 get_extended_attr_list ...................................................................................................................... 58 get_account_subscr .......................................................................................................................... 59 subscr_auth ...................................................................................................................................... 59 get_subscr_info ................................................................................................................................ 60 Example of get_subscr_info Returned Values ..................................................................... 64 create_custom_invoice .................................................................................................................... 97 get_account_campaigns ................................................................................................................... 98 HSPC/API/Account .................................................................................................................................... 99 create_customer ............................................................................................................................... 99 create_domain_contact .................................................................................................................. 101 create_reseller ................................................................................................................................ 102 get_account_info ........................................................................................................................... 103 Example of ACCOUNT_INFO Hash ................................................................................. 104 get_domain_contact_list ................................................................................................................ 106 get_reseller_terms .......................................................................................................................... 106 validate_password ......................................................................................................................... 106 get_extended_attr_list .................................................................................................................... 107 get_person_list ............................................................................................................................... 108 HSPC/API/Person ..................................................................................................................................... 110 auth_person.................................................................................................................................... 110 get_person_info ............................................................................................................................. 113 HSPC/API/Domain ................................................................................................................................... 114 check_domain_list ......................................................................................................................... 114 check_domain_name_syntax ......................................................................................................... 115 get_domain_list ............................................................................................................................. 115 validate_ns_list .............................................................................................................................. 116 save_contact .................................................................................................................................. 117 validate_domain_data .................................................................................................................... 118 HSPC/API/Mailer ..................................................................................................................................... 119 send ................................................................................................................................................ 119 HSPC/API/PP ........................................................................................................................................... 120 get_saved_paymethod_list ............................................................................................................. 120 get_plugin_list ..............................................................................................................................