از نسخه ۵۶ در نرمافزارهای cPanel و WHM، امکان انجام فرایندهای مدیریتی توسط دستورات خط فرمان بهبود یافته است و این امر به کاربران این نرمافزارها کمک خواهد کرد تا (API)های داخل این نرمافزارها را با خط فرمان نیز انجام داده و امتحان کنند.
پیش از این استفاده از (APIها در نرمافزارهای cPanel و WHM، نیازمند اسکریپتهای پیچیده بود و الیته احتمال خطای انسانی آن هم بالا بود. هماکنون ابزارهای API بسیار سادهتر شدهاند. برای مثال اگر بخواهید با ابزار UAPI لیست تنظیمات تمپلیتهای سایت را برای کاربر benny ببینید، از تابع زیر استفاده کنید.
[root@v56 ~ ]$ uapi –user=benny SiteTemplates list_user_settings — apiversion: 3 func: list_user_settings module: SiteTemplates result: data: – documentroot: /home/benny/public_html domain: benny.com homedir: /home/benny serveralias: – www.benny.com template_settings: businessHours: 1-7am businessHoursNotes: Closed weekends businessName: benny’s business description: This site is pretty nifty. descriptionSectionHeader: other stuff docroot: /home/benny/public_html domain_url: http://benny.com emailAddress: benny@benny.com facebookLink: ” faxNumber: ” googleMapsURL: ” google_analytics_key: ” is_empty: 0 linkedinLink: ” path: /usr/local/cpanel/etc/site_templates phoneNumber: ” physicalAddress: ” tagLine: stuff template: business twitterLink: ” type: main_domain errors: ~ messages: ~ metadata: transformed: 1 status: 1 [root@v56 ~ ]$ |
در صورتی که شما کاربر ریشه نیستید، پارامترهای مربوط به نام کاربری را حذف کنید.
[benny@v56 ~]$ uapi SiteTemplates list_user_settings — apiversion: 3 func: list_user_settings module: SiteTemplates result: data: – documentroot: /home/benny/public_html domain: benny.com homedir: /home/benny serveralias: – www.benny.com template_settings: businessHours: 1-7am businessHoursNotes: Closed weekends businessName: benny’s business description: This site is pretty nifty. descriptionSectionHeader: other stuff docroot: /home/benny/public_html domain_url: http://benny.com emailAddress: benny@benny.com facebookLink: ” faxNumber: ” googleMapsURL: ” google_analytics_key: ” is_empty: 0 linkedinLink: ” path: /usr/local/cpanel/etc/site_templates phoneNumber: ” physicalAddress: ” tagLine: stuff template: business twitterLink: ” type: main_domain errors: ~ messages: ~ metadata: transformed: 1 status: 1 [benny@v56 ~]$ |
تلاش برای اجرای هرگونه دستور با کاربری غیر از ریشه برای دستور (WHMAPI) بینتیجه بوده و با خطا مواجه خواهد شد.
[benny@v56 ~]$ whmapi1 cphulk_status [whmapi1] This program can only be run by root! whmapi1 Utility to execute WHM api calls whmapi1 [function] [key=value] [key=value] …. –output=[json|jsonpretty|xml|yaml] The serialization format to use for output. –help Prints this help text. [benny@v56 ~]$ |
در حالی که اجرای دستورات با کاربر ریشه نتیجهای متفاوت خواهد داشت.
[root@v56 ~ ]$ whmapi1 cphulk_status — data: is_enabled: 1 service: cPHulk metadata: command: cphulk_status reason: OK result: 1 version: 1 [root@v56 ~ ]$ |
در صورت نیاز به اطلاعات بیشتر و مستندات این سرویس میتوانید به (Software Development Kit) مراجعه کنید.