API

Index -> API -> Documentation for PHP library -> subHoster service

get_news_subhoster($poffset, $pcount)
List of news.

Parameters:
  • poffset - paging, offset
  • pcount - paging, number of items

Returns:
  • ok - data structure:
    • count - number of all items
    • items - array of items:
      • id - item ID
      • datetimeadd - addition date and time, format DD.MM.YYYY HH:MM:SS
      • title - title
      • body - text
get_price_list_domains_subhoster($fid_interface=NULL)
Domain price list.

Parameters:
  • fid_interface - filtrovanie podla ID rozhrania (not required)

Returns:
  • ok - data structure:
    • id - item ID
    • tld - TLD
    • price_registration - price for registration
    • price_renewal - price for renewal
    • price_special_registration - price for special registration
check_domain_password($domain, $tld)
Domain availability check.

Parameters:
  • domain - domain without TLD
  • tld - TLD

Returns:
  • inv_login - invalid login or password
  • nic_network_error - error while connecting to register
  • inv - invalid domain
  • reg - domain is not available
  • ok - domain is free
get_webhosting_packages($fid_interface=NULL)
Webhosting packages and addons.

Parameters:
  • fid_interface - filtrovanie podla ID rozhrania (not required)

Returns:
  • ok - data structure:
    • id - item ID
    • name - name
    • price - price
    • quota - disk quota
    • domain_count - limit for domains
    • subdomain_pd_count - limit for subdomains
    • mysql_acc_count - limit for MySQL accounts
    • mysql_db_count - limit for MySQL databases
    • ftp_count - limit for FTP / sftp accounts
    • email_pd_count - limit for e-mail accounts
    • email_alias_pd_count - limit for e-mail aliases
    • email_forw_pd_count - limit for e-mail forwards
    • crons_count - limit for crons
    • ram - limit for RAM
    • tasks - limit for running processes
    • ftp_backup - backing up of data on FTP:
      • 0 - not active
      • 1 - active
    • db_backup - backing up of databases:
      • 0 - not active
      • 1 - active
    • email_backup - backing up of e-mails:
      • 0 - not active
      • 1 - active
    • email_support - technical support via e-mail:
      • 0 - not active
      • 1 - active
    • im_support - technical support via chat:
      • 0 - not active
      • 1 - active
    • phone_support - technical support via phone:
      • 0 - not active
      • 1 - active
    • hidden - package is hidden:
      • 0 - no
      • 1 - yes
    • addon - is addon:
      • 0 - no
      • 1 - yes
    • sort_order - sort order
get_webhosting_domains_count_subhoster()
Number of hosted domains.

Vracia:
  • ok - data structure:
    • count - number of domains
check_user_login($login)
Login availability.

Parameters:
  • login - login

Returns:
  • exists - login is in use
  • ok - login is available
order_webhosting_subhoster($login, $password, $email, $iemail, $cell, $lang, $person_type, $title, $fname, $lname, $company, $street, $town, $zip, $country, $cid, $tid, $vid, $id_pack, $payment, $domains, $addons, $message=NULL, $coupon=NULL)
Order creation.

Parameters:
  • login - customer login
  • password - password
  • email - contact e-mail
  • iemail - invoicing e-mail
  • cell - phone number, format +421 123456789
  • lang - language ISO code
  • person_type - type of person:
    • FO - natural preson
    • FOP - natural person bussiness
    • PO - legal entity - busines
    • POI - legal entity other
  • title - title (not required)
  • fname - first name
  • lname - last name
  • company - business name (not required)
  • street - street and street number
  • town - town
  • zip - Postal code
  • country - country ISO code
  • cid - Company ID (not required)
  • tid - Tax ID (not required)
  • vid - VAT ID (not required)
  • id_pack - package ID
  • payment - payment (number of months), number from 1 to 12
  • domains - array of domains:
    • domain - domain without TLD
    • tld - TLD
    • nic_id - SK-NIC ID of owner (only for .sk domains)
    • name - first name of owner
    • surname - last name of owner
    • company - company name of owner
    • street - street and street number of owner
    • town - town of owner
    • pc - ZIP code of owner
    • cc - country ISO code of owner
    • phone - phone of owner, format +421 123456789
    • email - e-mail of owner
  • addons - array of IDs of addons
  • message - (not required)
  • coupon - discount coupon (not required)

Returns:
  • inv_lang - invalid parameter 'lang'
  • inv_person_type - invalid parameter 'person_type'
  • inv_login - invalid parameter 'login'
  • inv_payment - invalid parameter 'payment'
  • inv_payment_system - invalid parameter 'payment_system'
  • login_exists - login is in use
  • package_not_exists - package does not exist
  • addon_not_exists - addon does not exist:
    • id - ID of addon
  • inv_tld - invalid domain TLD:
    • domain - domain without TLD
    • tld - TLD
  • invoicing_error - error on invoicing backend:
    • state - error code
  • ok - command successful:
    • order_id - ID of order
    • id_ticket - ID of notice on due payment
    • ticket_number - number of notice on due payment
    • keyhash - keyhash of notice on due payment
get_references_password($count, $reg_only)
Random references in specified amount.

Parameters:
  • count - references amount
  • reg_only - return only domains registered via our system

Returns:
  • inv_login - invalid login or password
  • ok - data structure:
    • domain - domain without TLD
    • tld - TLD
get_order_subhoster($order_id)
Information about order.

Parameters:
  • order_id - ID of order

Returns:
  • not_exists - order doesn't exist
  • ok - data structure:
    • id - item ID
    • id_ticket - ID of notice on due payment
    • ticket_number - number of notice on due payment
    • datetimeadd - creation date and time, format DD.MM.YYYY HH:MM:SS
    • activated - activated:
      • 0 - no
      • 1 - yes
    • paid - paid:
      • 0 - no
      • 1 - yes
    • canceled - cancelled:
      • 0 - no
      • 1 - yes
    • login - login of webhosting
    • id_webhosting - ID of webhosting
    • items - items in order:
      • id - item ID
      • item_type - item type:
        • A - new addon
        • C - credit
        • N - new webhosting
        • P - webhosting renewal
        • RA - addon renewal
        • RD - domain registration
        • RDS - domain registration with new webhosting
        • RWD - domain renewal
      • id_item - ID of service
      • item_info - detail information about item
      • count - amount
      • activated - activated:
        • 0 - no
        • 1 - yes
add_webhosting_subhoster($login, $password, $email, $iemail, $cell, $lang, $person_type, $title, $fname, $lname, $company, $street, $town, $zip, $country, $cid, $tid, $vid, $id_pack, $expiration, $payment, $payment_system, $renewal_type, $addons_add, $ip_addresses, $groups)
Vytvorenie webhostingu.

Parameters:
  • login - customer login
  • password - password
  • email - contact e-mail
  • iemail - invoicing e-mail
  • cell - phone number, format +421 123456789
  • lang - language ISO code
  • person_type - type of person:
    • FO - natural preson
    • FOP - natural person bussiness
    • PO - legal entity - busines
    • POI - legal entity other
  • title - title
  • fname - first name
  • lname - last name
  • company - business name
  • street - street and street number
  • town - town
  • zip - Postal code
  • country - country ISO code
  • cid - Company ID
  • tid - Tax ID
  • vid - VAT ID
  • id_pack - package ID
  • expiration - expire date, format DD.MM.YYYY (not required)
  • payment - payment (number of months), number from 1 to 12
  • payment_system - payment system:
    • I - invoice
    • C - credit
  • renewal_type - typ predlzenia sluzieb:
    • G - pouzit globalne nastavenie
    • D - deaktivovat automaticke predlzenie
    • N - odosielat e-mailove upozornenia
    • O - vytvarat objednavky
  • addons_add - pole ID doplnkov, ktore sa maju pridat
  • ip_addresses - array of IP address IDs
  • groups - array of IDs of groups

Returns:
  • inv_lang - invalid parameter 'lang'
  • inv_person_type - invalid parameter 'person_type'
  • inv_login - invalid parameter 'login'
  • inv_payment - invalid parameter 'payment'
  • inv_expiration - invalid parameter 'expiration'
  • cannot_expire - exspiracia nemoze byt nastavena, pretoze zvoleny balik neexspiruje
  • inv_cell - invalid parameter 'cell'
  • login_exists - login is in use
  • login_too_long - login is too long
  • package_not_exists - package does not exist
  • addon_not_exists - addon does not exist:
    • id - ID of addon
  • interface_mismatch - doplnok je z ineho rozhrania ako balik:
    • id - ID of addon
  • type_mismatch - type of addon and package doesn't match:
    • id - ID of addon
  • ip_not_exists - IP address doesn't exist:
    • id - IP address ID
  • ip_server_mismatch - IP adresa sa nachadza na inom serveri ako webhosting:
    • id - IP address ID
  • invoicing_error - error on invoicing backend:
    • state - error code
  • ok - command successful:
    • id - ID of webhosting
get_webhosting_subhoster($id_service)
Information about webhosting.

Parameters:
  • id_service - ID of webhosting

Returns:
  • not_exists - webhosting doesn't exist
  • ok - command successful:
    • id - ID of webhosting
    • id_pack - package ID
    • package - package name
    • id_invoicing - invoicing ID
    • expiration - expire date, format DD.MM.YYYY
    • creation - creation date, format DD.MM.YYYY
    • payment - payment (number of months), number from 1 to 12
    • payment_system - payment system:
      • I - invoice
      • C - credit
    • renewal_type - typ predlzenia sluzieb:
      • G - pouzit globalne nastavenie
      • D - deaktivovat automaticke predlzenie
      • N - odosielat e-mailove upozornenia
      • O - vytvarat objednavky
    • delete_after_expiration - hodnoty:
      • 0 - webhostingu nebude zruseny ihned po exspiracii
      • 1 - webhosting sa automaticky zrusi ihned po exspiracii
    • user - customer login
    • email - contact e-mail
    • cell - phone number, format +421 123456789
    • lang - language ISO code
    • addons:
      • id - ID of addon
      • creation - creation date, format DD.MM.YYYY
      • name - addon name
      • count - number of addons
    • ip_addresses:
      • id - item ID
      • ip - IPv4 address
      • ipv6 - IPv6 address
      • server - server name
    • groups:
      • id - item ID
      • name - group name
get_webhostings_subhoster($poffset, $pcount, $flogin=NULL, $fgroup=NULL, $femail=NULL, $fpackage=NULL, $fpackage_type=NULL, $fexpirationfrom=NULL, $fexpirationto=NULL)
Funkcia vrati zoznam webhostingov.

Parametre:
  • poffset - paging, offset
  • pcount - paging, number of items
  • flogin - filtrovanie podla loginu (not required)
  • fgroup - filtrovanie podla skupiny (not required)
  • femail - filtrovanie podla kontaktneho e-mailu (not required)
  • fpackage - filtrovanie podla nazvu baliku (not required)
  • fpackage_type - filtrovanie podla typu baliku (not required):
    • W - webhostings
    • V - VPS servers
  • fexpirationfrom - filtrovanie podla datumu exspiracie (od) (not required)
  • fexpirationto - filtrovanie podla datumu exspiracie (do) (not required)

Vracia:
  • ok - zoznam vrati v 'data', struktura:
    • count - pocet vratenych poloziek
    • items - pole:
      • id - ID polozky
      • id_pack - ID baliku
      • package - nazov baliku
      • expiration - datum exspiracie, format DD.MM.RRRR
      • creation - datum a cas vytvorenia, format DD.MM.RRR HH:MM:SS
      • payment - frekvencia platby
      • user - login
change_webhosting_subhoster($id_service, $id_pack, $expiration, $payment, $payment_system, $renewal_type, $addons_add, $addons_del, $ip_addresses, $groups, $delete_after_expiration)
Upravenie webhostingu.

Parameters:
  • id_service - ID of webhosting
  • id_pack - package ID
  • expiration - expire date, format DD.MM.YYYY (not required)
  • payment - payment (number of months), number from 1 to 12
  • payment_system - payment system:
    • I - invoice
    • C - credit
  • renewal_type - typ predlzenia sluzieb:
    • G - pouzit globalne nastavenie
    • D - deaktivovat automaticke predlzenie
    • N - odosielat e-mailove upozornenia
    • O - vytvarat objednavky
  • addons_add - pole ID doplnkov, ktore sa maju pridat
  • addons_del - array of IDs of addons to remove
  • ip_addresses - array of IP address IDs
  • groups - array of IDs of groups
  • delete_after_expiration - nastavit webhosting, aby bol zruseny ihned po exspiracii, ziadne upozornenia na exspiraciu uz nebudu zaslane

Returns:
  • inv_payment - invalid parameter 'payment'
  • inv_payment_system - invalid parameter 'payment_system'
  • inv_expiration - invalid parameter 'expiration'
  • cannot_expire - exspiracia nemoze byt nastavena, pretoze zvoleny balik neexspiruje
  • not_exists - webhosting doesn't exist
  • package_not_exists - package does not exist
  • addon_not_exists - addon does not exist:
    • id - ID of addon
  • interface_mismatch - doplnok je z ineho rozhrania ako balik:
    • id - ID of addon
  • type_mismatch - type of addon and package doesn't match:
    • id - ID of addon
  • ip_not_exists - IP address doesn't exist:
    • id - IP address ID
  • ip_server_mismatch - IP adresa sa nachadza na inom serveri ako webhosting:
    • id - IP address ID
  • ok - command successful
add_webhosting_domain_subhoster($domain, $tld, $id_service, $id_ip, $id_domain)
Pridanie domeny na webhosting.

Parameters:
  • domain - domain without TLD
  • tld - TLD
  • id_service - ID of webhosting
  • id_ip - IP address ID (not required)
  • id_domain - ID domeny, pre ktoru bude nova domena aliasom (not required)

Returns:
  • webhosting_not_exists - webhosting doesn't exist
  • ip_not_exists - IP address doesn't exist
  • ip_server_mismatch - IP adresa sa nachadza na inom serveri ako webhosting
  • inv_id_domain - invalid parameter 'id_domain'
  • inv_domain - invalid parameter 'domain'
  • inv_tld - invalid parameter 'tld'
  • exists - domena uz v systeme existuje
  • ok - command successful:
    • id - domain ID