...
| Excerpt |
|---|
|
apnscp is the Apis Networks Control Panel. A perfect hosting platform for your PHP, Ruby, Node, Python, and Go projects. Enable SSL with 1-click, automatically update webapps, scan for OS anomalies, receive notification of service defects, block threats real-time, and keep your site operating at peak performance. |
| Table of Contents |
|---|
| Table of Contents |
|---|
| maxLevel | 4 |
|---|
| minLevel | 2 |
|---|
| outline | true |
|---|
| class | toc |
|---|
|
|
About APNSCP
APNSCP is a shared web hosting control panel know as the Apis Networks Control Panel. Learn more about APNSCP on their website at https://apnscp.com/.
Supported Features
| Create | Cancel | Suspend | Unsuspend | Management | Config Options |
|---|
| | | | | |
Management Features
This module supports the following management features within the client area:
...
Enter the details for your APNSCP server.
| Field Name | Description |
|---|
| Server Label | Enter a label for this APNSCP server, it can be anything you like. |
| Hostname | Enter the FQDN hostname for your APNSCP server, ie "server1.domain.com". |
| Port | Enter your APNSCP port, typically 2083. |
| API Key | Enter your APNSCP token, found under "Dev" > "API Keys". |
| Use SSL when connecting to the API | Check this option to use SSL for all API requests to your APNSCP server. This is highly recommended. |
| Account Limit | Enter the maximum number of accounts that should be added to this APNSCP server. |
| Name Servers | Enter the name servers that should be used for this server. These will be available to the package welcome email to the client. |
| Notes | Enter any notes that pertain to this server for future reference. |
After filling out these options, click "Add Server" to add your APNSCP server.
...
To add a server group, from the APNSCP overview at [Settings] > [Company] > [Modules] > APNSCP, click "Add Server Group", then enter the details.
| Option | Details |
|---|
| Group Name | Enter the name for this server group. |
| Add Order | Choose how servers in this group will be selected for provisioning. Currently, first non-full server is the only add order. |
| Assigned Servers | Select servers under "Available Servers" and click to move them to the left column to add them to the group. |
Creating Packages
Packages define the pricing, welcome email, module and more. Packages can be assigned to Package Groups, and added to Order Forms. To create a Package, visit [Packages] > Browse, and click the "Create Package" button.
...
The Basic section consists of the following options:
| Field Name | Description |
|---|
| Package Name | Enter the name of this Package, it will be visible wherever services are listed and on any order forms. |
| Status | "Active" is the default, "Inactive", and "Restricted" are also available. |
| Quantity Available | If this Package has a limited quantity available, enter the quantity, or leave it as "Unlimited". |
| Use renewal prices for package upgrades | When enabled, upgrading to this package will use renewal prices if they are set. The same will apply to any configurable options that are altered in the upgrade. The regular price will be used if this setting is disabled. |
| Description | Enter a Description for this Package. HTML is allowed, and descriptions appear on order forms. |
| Configurable Options | A Configurable Option Group may be selected if previously created, but this module does not support configurable options during provisioning. |
| Module | Select "APNSCP" for the module. |
Module Options
The Module Options section consists of the following options, which are specific to APNSCP:
| Field Name | Description |
|---|
| Server Group | Select "Any" if you wish to specify a specific server, or select the Server Group to provision from. Selecting a group means that accounts will be provisioned from the group. Selecting a group is recommended. |
| APNSCP Package | Select the APNSCP Package to use when configuring accounts. |
Pricing
| Field Name | Description |
|---|
| Term | Enter the term for the desired pricing option. For example, if you wish to create a 3 month pricing option, enter 3 here. |
| Period | Select the period for this pricing option. "Day", "Week", "Month", "Year", and "One time" are options. The client will be invoiced every "term period", for example every 3 months if 3 is entered for term, and Month is selected for period. |
| Currency | Select the currency this pricing option is available for. |
| Price | Enter the price for this pricing option. |
| Setup Fee | If there is a setup fee, enter it here. |
| Cancellation Fee | If there is a fee to cancel early, enter it here. |
Click the "Add Additional Price" to add more pricing options. It's common for people to create 1 Month, 3 Month, 6 Month, and 1 Year price options. There are many possible combinations.
...
When creating or editing a package that uses this module, the following tags will be available:
| Tags | Description | Notes |
|---|
| {module.host_name} | The host name of the server that the service was provisioned on | e.g. "domain.com" |
| {module.name_servers} | An array of available name servers for this module | Array elements must be looped over in the email template. See below for an example. |
| {package.package} | The package meta package name | e.g. "Bronze" |
| {service.apnscp_username} | The service field for the APNSCP account username |
|
| {service.apnscp_password} | The service field for the APNSCP account password |
|
| {service.apnscp_domain} | The service field for the APNSCP domain | e.g. "domain.com" |
| Expand |
|---|
|
Due to the nature of tag objects containing several fields, many of which are likely irrelevant for use in email templates, but may be useful to you in certain circumstances, a dump of the tags are shown below. | Code Block |
|---|
| language | php |
|---|
| title | The {module} object |
|---|
| collapse | true |
|---|
| stdClass Object
(
[host_name] => domain.com
[name_servers] => Array
(
[0] => ns1.domain.com
[1] => ns2.domain.com
)
) |
| Code Block |
|---|
| language | php |
|---|
| title | The {package} object |
|---|
| collapse | true |
|---|
| stdClass Object
(
[id] => 322
[id_format] => {num}
[id_value] => 12
[moduleid_idvalue] => 42
[name] => Package Name
[descriptionid_code] => Package Text Description2
[description_html] => <h1>Package HTML Description</h1>
[qtymodule_id] => 3
[module_row] => 6
[module_groupname] => APNSCP Hosting
[taxable] => 0
[statusdescription] => active
[company_id] => 1
[iddescription_codehtml] => 12
[email_content] => Array
[qty] => (
[0module_row] => stdClass Object2
[module_group] => (
[taxable] => 0
[lang [single_term] => en_us0
[status] => active
[htmlcompany_id] => 1
<p>Welcome email html</p>
[prorata_day] =>
[textprorata_cutoff] => Welcome email text
[upgrades_use_renewal] => )1
)
[pricingemail_content] => Array
(
(
[0] => stdClass Object
[0] => stdClass (Object
[id] => 43
(
[term] => 123
[periodlang] => dayen_us
[price] => 3.0000
[html] => <p>Your hosting account details [setup_fee] => 0.0000are below!</p>
<p>Domain: {service.apnscp_domain}<br />
Username: {service.apnscp_username}<br />
Password: {service.apnscp_password}</p>
<p>To log into your control panel please visit https://{module.host_name}:2083.<br />
Please update your name servers as soon as possible to the following:</p>
<p>{% for name_server in module.name_servers %}<br />
Name server: {name_server}{% endfor %}</p>
<p>-- debug --</p>
<p>{% debug %}</p>
[text] => Your hosting account details are below!
Domain: {service.apnscp_domain}
Username: {service.apnscp_username}
Password: {service.apnscp_password}
To log into your control panel please visit https://{module.host_name}:2083.
Please update your name servers as soon as possible to the following:
{% for name_server in module.name_servers %}
Name server: {name_server}{% endfor %}
-- debug --
{% debug %}
)
) |
| Code Block |
|---|
| language | php |
|---|
| title | The {service} object |
|---|
| collapse | true |
|---|
| stdClass Object
(
[id] => 2
[parent_service_id] =>
[package_group_id] => 3
[id_format] => {num}
[id_value] => 2
[pricing_id] => 2
[client_id] => 1
[module_row_id] => 2
[coupon_id] =>
[qty] => 1
[override_price] =>
[override_currency] =>
[status] => active
[suspension_reason] =>
[date_added] => 2019-12-16 21:34:40
[date_renews] => 2020-01-16 21:34:40
[date_last_renewed] =>
[date_suspended] =>
[date_canceled] =>
[id_code] => 2
[fields] => Array
(
[0] => stdClass Object
(
[key] => apnscp_domain
[value] => domain.com
[serialized] => 0
[encrypted] => 0
)
[1] => stdClass Object
(
[key] => apnscp_password
[value] => password1728
[serialized] => 0
[encrypted] => 1
)
[2] => stdClass Object
(
[key] => apnscp_username
[value] => domaincom
[serialized] => 0
[encrypted] => 0
)
)
[options] => Array
(
)
[package_pricing] => stdClass Object
(
[id] => 2
[package_id] => 2
[pricing_id] => 2
[term] => 1
[period] => Month
[price] => 3.5000
[price_renews] => 3.5000
[setup_fee] => 0.0000
[cancel_fee] => 0.0000
[currency] => USD
)
[package] => stdClass Object
(
[id] => 2
[id_format] => {num}
[id_value] => 2
[id_code] => 2
[module_id] => 3
[name] => APNSCP Hosting
[description] =>
[description_html] =>
[qty] =>
[module_row] => 2
[module_group] =>
[taxable] => 0
[single_term] => 0
[status] => active
[company_id] => 1
[prorata_day] =>
[prorata_cutoff] =>
[upgrades_use_renewal] => 1
[email_content] => Array
(
[0] => stdClass Object
(
[lang] => en_us
[html] => <p>Your hosting account details are below!</p>
<p>Domain: {service.apnscp_domain}<br />
Username: {service.apnscp_username}<br />
Password: {service.apnscp_password}</p>
<p>To log into your control panel please visit https://{module.host_name}:2083.<br />
Please update your name servers as soon as possible to the following:</p>
<p>{% for name_server in module.name_servers %}<br />
Name server: {name_server}{% endfor %}</p>
<p>-- debug --</p>
<p>{% debug %}</p>
[text] => Your hosting account details are below!
Domain: {service.apnscp_domain}
Username: {service.apnscp_username}
Password: {service.apnscp_password}
To log into your control panel please visit https://{module.host_name}:2083.
Please update your name servers as soon as possible to the following:
{% for name_server in module.name_servers %}
Name server: {name_server}{% endfor %}
)
)
[pricing] => Array
(
[0] => stdClass Object
(
[id] => 2
[pricing_id] => 2
[package_id] => 2
[term] => 1
[period] => month
[price] => 3.5000
[price_renews] => 3.5000
[setup_fee] => 0.0000
[cancel_fee] => 0.0000
[currency] => USD
)
)
[meta] => stdClass Object
(
[package] => basic
)
[groups] => Array
(
[0] => stdClass Object
(
[id] => 3
[type] => standard
[cancel_fee [name] => 0.0000
Shared Hosting
[currency [description] => AUD
)
[1company_id] => stdClass Object1
(
[idallow_upgrades] => 421
[term] => 0
[periodnames] => onetimeArray
[price] => 2.0000
[setup_fee] => 0.0000
(
[cancel_fee] => 0.0000
[currency0] => USDstdClass Object
)
)
[meta] => stdClass Object
(
(
[package] => Bronze
[type] => standard
)
[groups] => Array
(
[0lang] => en_us
stdClass Object
(
[id] => 2
[name] => Shared Hosting
[name] => Standard Group
[type] => standard
)
)
[package] => Bronze
[type] => standard
) | | Code Block |
|---|
| language | php |
|---|
| title | The {service} object |
|---|
| collapse | true |
|---|
| stdClass Object
(
[id] => 124
[parent_service_id] =>
[id_format] => {num} )
[id_value] => 119
[pricing_id] => 42
[client_id] => 3
[module_row_id] => 6
[coupon_id] =>
[qtydescriptions] => 1Array
[status] => active
[date_added] => 2013-03-07 18:57:45
[date_renews] =>
[date_last_renewed] =>
[date_suspended] =>
[date_canceled] => (
[id_code] => 119
[fields] => Array
(
[0] => stdClass Object
)
(
[key] => cpanel_domain
)
[value] => domain.com )
[serializedoption_groups] => 0
Array
(
[encrypted] => 0
)
[1 [plugins] => stdClass ObjectArray
(
(
[key] => cpanel_password
)
[value] => password
[names] => Array
[serialized] => 0
(
[encrypted] => 1
)
[0] => stdClass Object
[2] => stdClass Object
(
(
[key] => cpanel_username
[valuelang] => domainco
en_us
[serialized] => 0
[encryptedname] => APNSCP 0Hosting
)
)
[package_pricing] => stdClass Object)
(
[id] => 42
)
[package_id] => 32
[termdescriptions] => 0Array
[period] => One time
(
[price] => 2.0000
[setup_fee] => 0.0000
[cancel_fee0] => 0.0000stdClass Object
[currency] => USD
)
[package] => stdClass Object(
(
[id] => 32
[id_formatlang] => {num}en_us
[id_value] => 12
[module_id] => 4
[html] =>
[name] => Package Name
[description] => Package Text Description
[description_htmltext] => <h1>Package HTML Description</h1>
[qty] => 3
[module_row] => 6
)
[module_group] =>
[taxable] => 0)
[status] => active )
[company_idname] => 1blesta.biz
)
[nameapnscp_domain] => domain.com
[cpanel_domain] => domain.com
[cpanelapnscp_password] => passwordpassword1234
[cpanel [apnscp_username] => domainco
domaincom
) |
|
Displaying Name Servers in the Welcome Email
...