Client's library in PHP5 II. - methods' and functions' description (Cznic module)

Description of methods and functions of ZMS system

Contents

1. Common functions
   • login
2. Contacts' manipulation
   • contactCreate
   • contactDeleteByPassword
   • contactTransfer
   • contactUpdateByPassword
   • contactCheck
   • contactWhois
   • contactSendPassword
   • contactSendAuthInfo
3. Manipulations with NSSETs (nameservers' sets)
   • nssetCreate
   • nssetDeleteByPassword
   • nssetTransfer
   • nssetUpdateByPassword
   • nssetCheck
   • nssetWhois
   • nssetSendAuthInfo
   • nssetListDomains
4. Manipulation with Domains
   • domainCreate
   • domainRenew
   • domainTransfer
   • domainUpdateByPassword
   • domainCheck
   • domainWhois
   • domainSendAuthInfo
   • domainListInvoiced
   • domainListToBeDeleted
5. Manipulations with KEYSETs (set of keys)
   • keysetCreate
   • keysetDeleteByPassword
   • keysetTransfer
   • keysetUpdateByPassword
   • keysetCheck
   • keysetWhois
   • keysetSendAuthInfo
   • keysetListDomains

1. Common functions

• login

  Authentization in system

  Input parameters:

  Required parameters:

  • id_user - User's name
  • password - password
  • remote_addr - IP address of client, e.g.: $_SERVER['REMOTE_ADDR'];

  Optional parameters:

  none

2. Manipulation with contacts

• contactCreate

  Creation of new contact

  Input parameters:

  Required parameters:

  • id - Identificator - Contact's name. Must be unique in whole CZ domain database. It is possible to insert for example surname, name or abbreaviation of firm.
  • name - Name and surname - Person, contact's owner.
  • street_1 - Address of organization, contact's owner.
  • city - City
  • pc - Postcode
  • cc - Country
  • email - E-mail of contact's owner. All passwords for authorization of requests are sent to e-mail. It is very important for e-mail to function.

  Optional parameters:

  • disclose_email - Values: 0/1
    If the value is set up to 0, so it will prevent display of item Email in list WHOIS
  • org - Name of organization
  • street_2 - Address of organization, contact's owner 2
  • street_3 - Address of organization, contact's owner 3
  • sp - Provincion
  • vat - VAT number
  • disclose_vat - Values: 0/1
    If the value is set up to 0, so it will prevent display of item Vat in list WHOIS
  • fax - Fax of contact's owner. Example of format: +420.123456789
  • disclose_fax - Values: 0/1
    If the value is set up to 0, so it will prevent display of item Fax in list WHOIS
  • voice - Phone of contact's owner. Example of format: +420.123456789
  • disclose_voice - Values: 0/1
    If the value is set up to 0, so it will prevent display of item Voice in list WHOIS
  • notify_email - E-mail for notification. It is used for sending the information from CZ.NIC about realization of any operations with contact.
  • disclose_notify_email - Values: 0/1
    If the value is set up to 0, so it will prevent display of item NotifyEmail in list WHOIS
  • ident_type - Identificator is used for concrete determination of owner and contact's administrator.
    It can include these values:
    • empty
    • op - ID card number
    • passport - passport number
    • mpsv - Social security number
    • ico - Id number
    • birthday - date of birth
  • ident_value - Value of identificator IdentType
  • disclose_ident - Values: 0/1
    If the value is set up to 0, so it will prevent display of items IdentType/IdentValue in list WHOIS
  • auth_info - Authorization password stored in organization CZ.NIC. It is used for potentional contact's registrar change. Password should have min. 8 signs and include numbers.

  Output parameters::

  none

• contactDeleteByPassword

  Contact's removal.

  Input parameters:

  Required parameters:

  • id - Identificator - Contact's name. Must be unique in whole CZ domain database. It is possible to insert for example surname, name or abbreaviation of firm.
  • password - Zoner Authorization code

  Optional parameters:

  none

  Output parameters:

  none

• contactTransfer

  Transfer of contact

  Input parameters:

  Required parameters:

  • id - Identificator - Contact's name. Must be unique in whole CZ domain database. It is possible to insert for example surname, name or abbreaviation of firm.
  • current_auth_info - Authorization password of Central register CZ.NIC is used for domain transfer to another registrar.

  Optional parameters:

  none

  Output parameters:

  none

• contactUpdateByPassword

  Contact adjustment by means of password

  Input parameters:

  Required parameters:

  • id - Identificator - Contact's name.
  • password - Zoner Authorization code

  Optional parameters:

  • name - Name and surname - Person, contact's owner.
  • street_1 - Address of organization, contact's owner.
  • city - City
  • pc - Postcode
  • cc - Country
  • email - E-mail of contact's owner. All passwords for authorization of requests are sent to e-mail. It is very important for e-mail to function.
  • disclose_email - Values: 0/1
    If the value is set up to 0, so it will prevent display of item Email in list WHOIS
  • org - Name of organization
  • street_2 - Address of organization, contact's owner 2
  • street_3 - Address of organization, contact's owner 3
  • sp - Provincion
  • vat - VAT number
  • disclose_vat - Values: 0/1
    If the value is set up to 0, so it will prevent display of item Vat in list WHOIS
  • fax - Fax of contact's owner. Example of format: +420.123456789
  • disclose_fax - Values: 0/1
    If the value is set up to 0, so it will prevent display of item Fax in list WHOIS
  • voice - Phone of contact's owner. Example of format: +420.123456789
  • disclose_voice - Values: 0/1
    If the value is set up to 0, so it will prevent display of item Voice in list WHOIS
  • notify_email - E-mail for notification. It is used for sending the information from CZ.NIC about realization of any operations with contact.
  • disclose_notify_email - Values: 0/1
    If the value is set up to 0, so it will prevent display of item NotifyEmail in list WHOIS
  • ident_type - Identificator is used for concrete determination of owner and contact's administrator.
    It can include these values:
    • empty
    • op - ID card number
    • passport - passport number
    • mpsv - Social security number
    • ico - Id number
    • birthday - date of birth
  • ident_value - Value of identificator IdentType
  • disclose_ident - Values: 0/1
    If the value is set up to 0, so it will prevent display of items IdentType/IdentValue in list WHOIS
  • auth_info - Authorization password stored in organization CZ.NIC. It is used for potentional contact's registrar change. Password should have min. 8 signs and include numbers.

  Notifications and exception:

  Non-obligatory items deletion

  Items, which are not obligatory, can be deleted by sending NULL value as parameter (case-sensitive) - for example 'fax' => 'NULL' You can not set empty 'notify_email' once it has been set. More exceptions are included in address update.

  Contact address update

  Contact address details can be only updated together. You must send all following parameters: street_1, street_2, street_3, city, pc, cc. Non-obligatory parameters street_2, street_3 can be set to empty by sending empty string.

Output parameters:

none

3. Manipulation with NSSETs (sets of nameservers)

• nssetCreate

  Creation of new set of nameservers.

  Set of nameservers can include up to 10 nameservers. In the set order is not defined and it is necessary to enter domain name of min. two NS. If domain name of NS is in CZ zone, it is eventually possible to add to NS also its Glue records (IP addresses - parameter: NsAddr).

  Input parameters:

  Required parameters:

  • id - Identificator - Set of nameservers name. Must be unique in whole CZ domain database. It is possible to insert for example name characterising DNS use.
  • ns_name_1 - Primary nameserver. Domain's name
  • ns_name_2 - Secondary nameserver. Domain's name
  • tech - Technical administrators
  • report_level - Recommended value: 1

  Optional parameters:

  • ns_name_3 - 3. nameserver. Domain's name
  • ns_name_4 - 4. nameserver. Domain's name
  • ns_name_5 - 5. nameserver. Domain's name
  • ns_name_6 - 6. nameserver. Domain's name
  • ns_name_7 - 7. nameserver. Domain's name
  • ns_name_8 - 8. nameserver. Domain's name
  • ns_name_9 - 9. nameserver. Domain's name
  • ns_name_10 -10. nameserver. Domain's name
  • ns_addr_1 - 1. IP address (Glue sentence)
  • ns_addr_2 - 2. IP address (Glue sentence)
  • ns_addr_3 - 3. IP address (Glue sentence)
  • ns_addr_4 - 4. IP address (Glue sentence)
  • ns_addr_5 - 5. IP address (Glue sentence)
  • ns_addr_6 - 6. IP address (Glue sentence)
  • ns_addr_7 - 7. IP address (Glue sentence)
  • ns_addr_8 - 8. IP address (Glue sentence)
  • ns_addr_9 - 9. IP address (Glue sentence)
  • ns_addr_10 - 10. IP address (Glue sentence)
  • auth_info - Set of nameservers password in central register CZ.NIC. It is not given, it is generated by server

• nssetTransfer

  Transfer of contact

  Input parameters:

  Required parameters:

  • id - Identificator - Set of nameservers name. Must be unique in whole CZ domain database. It is possible to insert for example name characterising DNS use.
  • current_auth_info - Authorization password of Central register CZ.NIC

  Optional parameters:

  none

  Output parameters:

  none

• nssetUpdateByPassword

  Change of set of nameservers data

  Input parameters:

  Required parameters:

  • id - Identificator - Set of nameservers name. Must be unique in whole CZ domain database. It is possible to insert for example name characterising DNS use.
  • auth_info - Authorization password stored in CZ.NIC organization. It is used for potential change of contact's registrar. Password should have at least 8 signs and include numbers.
  • contact - contact's id
  • password - Zoner Authorization code

  Optional parameters:

  none

  Output parameters:

  none

• nssetCheck

  Control of availability/existence of set of nameservers.

  Input parameters:

  Required parameters:

  • id - Identificator - Set of nameservers name. Must be unique in whole CZ domain database. It is possible to insert for example name characterising DNS use.

  Optional parameters:

  none

  Output parameters:

  • avail - Int: 1 -> set of nameservers don't exist; Int: 0 -> set of nameservers exist

• nssetWhois

  WHOIS of set of nameservers

  Parameters:

  Required parameters:

  • id - Identificator - Set of nameservers name. Must be unique in whole CZ domain database. It is possible to insert for example name characterising DNS use.

  Optional parameters:

  none

  Output parameters:

  • id - Identificator - Set of nameservers name. Must be unique in whole CZ domain database. It is possible to insert for example name characterising DNS use.
  • cl_id - Given registrar
  • cr_date - Date of creation
  • cr_id - contact's id, which created this set of nameservers
  • ns_name - Typ: table - Domain's names of set of nameservers
  • ns_addr - Typ: table - IP addresses of nameservers
  • tech - Typ: table - Identificators of Technical contacts

• nssetListDomains

  List/number of domains using given nsset

  Input parameters:

  Required parameters:

  • id - Identificator - Set of nameservers name. Must be unique in whole CZ domain database. It is possible to insert for example name characterising DNS use.
  • count_only - 'True' -> Function returns only number of domains

  Optional parameters:

  none

  Output parameters:

  • list - List of domains
  • list_count - Number of domains

• nssetSendAuthInfo

  Sending of set of nameservers AuthInfo to E-Mail.

  Input parameters:

  Required parameters:

  • id - Identificator - Set of nameservers name. Must be unique in whole CZ domain database. It is possible to insert for example name characterising DNS use.

  Optional parameters:

  none

  Output parameters:

  none

• nssetDeleteByPassword

  Removal of set of nameservers

  Input parameters:

  Required parameters:

  • id - Identificator - Set of nameservers name. Must be unique in whole CZ domain database. It is possible to insert for example name characterising DNS use.
  • contact - contact's id
  • password - Zoner Authorization code

  Optional parameters:

  none

  Output parameters:

  none

4. Manipulation with domains

• domainCreate

  Creation of new domain.

  Input parameters:

  Required parameters:

  • domain_name - Domain's name in format: domainname.cz
  • period - 1 to 10 - Is number of years, for which domain is registred.
  • registrant - Contact ID of domain owner
  • admin - Typ: table - List of contacts
  • auth_info - Authorization password stored in CZ.NIC organization. It is used for potential change of domain registrar. Password should have at least 8 signs and include numbers.

  Optional parameters:

  • spec_reg - 0/1 - order domain as special registration
  • nsset - Id of set of nameservers for this domain
  • keyset - Id of set of keys for this domain

• domainRenew

  Prolongation of domain.

  Input parameters:

  Required parameters:

  • domain_name - Domain's name in format: domainname.cz
  • period - 1 to 10 - Is number of years, for which domain is prolonged.

  Optional parameters:

  • respond_to - where to send renew result
  • request_id - own identification number application

• domainTransfer

  Transfer of domain

  Parameters:

  Required parameters:

  • domainName - Domain's name
  • current_auth_info - Authorization password of Central register CZ.NIC

  Optional parameters:

  • nsset - id of nameservers' sets

  Output parameters:

  none

• domainUpdateByPassword

  Domain's adjustment by means of password

  Input parameters:

  Required parameters:

  • contact - contact's id
  • domain_name - Domain's name
  • password - Zoner Authorization code

  Optional parameters:

  • nsset - new NSSET ID
  • keyset - new KEYSET ID
  • admin_add - Type: table list of admin-c ID's to add
  • admin_rem - Type: table Sist of admin-c ID's to remove
  • auth_info - new CZNIC auth password. Must contain at leat 8 symbols, at least one number is required
  • temp_contact_rem - Type: table list of temporary-contact ID's to remove

• domainCheck

  Control of availability/existence of contact.

  Input parameters:

  Required parameters:

  • domain_name - Domain's name

  Optional parameters:

  none

  Output parameters:

  • avail - 1 -> domain does not exist; 0 -> contact exists

• domainWhois

  WHOIS domains

  Parameters:

  Required parameters:

  • domain_name - Domain's name

  Optional parameters:

  none

  Output parameters:

  • domain_name - Domain's name
  • registrant - Holder. Change of holder is realised by substituting current contact with new, already existant contact. If the new contact does not exist, it is necessary to create it first.
  • nsset - Set of nameservers
  • ex_date - Expiration date
  • cl_id - Given registrar
  • cr_date - Date of domain registration
  • up_date - Date of last up-date
  • admin - Typ: table List of admin contacts
  • temp_contact - Typ: table List of temp contacts

• domainSendAuthInfo

  Sending of AuthInfo domain to E-Mail

  Parameters:

  Required parameters:

  • domain_name - Domain's name

  Optional parameters:

  none

  Output parameters:

  none

• domainListInvoiced

  Return list of domains paid by given account

  Parameters:

  Required parameters:

  none

  Output parameters:

  list - Type: table List of domains

• domainListToBeDeleted

  Return list of domains that will be released for new registration.

  Parameters:

  Required parameters:

  none

  Output parameters:

  list - Typ: table List of domains and date of releasing

  • a - domain name
  • b - date of releasing

5. Manipulations with KEYSETs (set of keys)

• keysetCreate

  Creation of new set of keys.

  Set of keys can include up to 10 DNS keys. In the set order is not defined and it is necessary to enter domain name of min. one DNS key.

  Input parameters:

  Required parameters:

  • id - Identificator - Set of keys name. Must be unique in whole CZ domain database. It is possible to insert for example name characterising DNS use.
  • dns_key - Table of DS record:
    • a - flags (257 = KSK, 256 = ZSK)
    • b - algorithm (5 = RSA/SH1)
    • c - protocol (3 = DNSSEC)
    • d - public key
  • tech - Technical administrators

  Optional parameters:

  • auth_info - Set of keys password in central register CZ.NIC. It is not given, it is generated by server

• keysetTransfer

  Transfer of set of keys

  Input parameters:

  Required parameters:

  • id - Identificator - Set of keys name
  • current_auth_info - Authorization password of Central register CZ.NIC

  Optional parameters:

  none

  Output parameters:

  none

• keysetUpdateByPassword

  Change of set of keys data.

  Input parameters:

  Required parameters:

  • id - Identificator - Set of keys name
  • contact - contact's id
  • password - contact's Zoner Authorization code

  Optional parameters:

  • dns_key_add - Table of new DNS key to add:
    • a - flags (257 = KSK, 256 = ZSK)
    • b - algorithm (5 = RSA/SH1)
    • c - protocol (3 = DNSSEC)
    • d - public key
  • dns_key_rem - Table of current DNS key to remove:
    • a - flags (257 = KSK, 256 = ZSK)
    • b - algorithm (5 = RSA/SH1)
    • c - protocol (3 = DNSSEC)
    • d - public key
  • tech_rem - Table of current technical contact to remove.
  • tech_add - Table of new technical contact to add
  • auth_info - New password of set of keys of Central register CZ.NIC

  Output parameters:

  none

• keysetCheck

  Control of availability/existence of set of keys.

  Input parameters:

  Required parameters:

  • id - Identificator - Set of keys name

  Optional parameters:

  none

  Output parameters:

  • avail - Int: 1 -> set of keys don't exist; Int: 0 -> set of keys exist

• keysetWhois

  WHOIS of set of keys

  Input parameters:

  Required parameters:

  • id - Identificator - Set of keys name.

  Optional parameters:

  none

  Output parameters:

  • id - Identificator - Set of keys name.
  • cl_id - Given registrar
  • cr_date - Date of creation
  • cr_id - Contact's id, which created this set of keys
  • up_id - Identifikátor registrátora, který sadu klíčů naposledy změnil
  • up_date - Date of last change of set of keys
  • tr_date - Date of last transfer of set of keys to given registrar
  • dns_key - Table of DNS keys:
  • a - flags (257 = KSK, 256 = ZSK)
  • b - algorithm (5 = RSA/SH1)
  • c - protocol (3 = DNSSEC)
  • d - public key
• tech - Type: table - Identificators of Technical contacts

back