API


check_domain($domain, $tld)
Domain check.

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

Returns:
  • reg - domain is already registered
  • free - domain is free
  • inv - invalid domain name
  • not_aval - domain is not available for registration
  • unknown - unknown answer from register
  • connect_error - pripojenie do registra bolo neuspesne
domain_info($domain, $tld)
Information about domain.

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

Returns:
  • free - domain is not registered
  • inv - invalid domain name
  • unknown - unknown answer from SK-NIC
  • connect_error - pripojenie do registra bolo neuspesne
  • ok - command successful:
    • domain - domain with TLD
    • registrant - registrant contact
    • registrar - registrar contact
    • expires - expire date, format DD.MM.YYYY
    • ns1 - DNS server 1
    • ns2 - DNS server 2
    • ns3 - DNS server 3
    • ns4 - DNS server 4
domain_info_bulk($domains)
Bulk domain information, maximum 25.

Parameters:
  • domains - array of domains without TLD

Returns:
  • no_perm - you don't have a permission for this action
  • too_much - you have send more than 25 domains
  • connect_error - pripojenie do registra bolo neuspesne
  • ok - command successful, struktura dat je rovnaka ako pri domain_info()
user_info($nicid)
Information about contact.

Parameters:
  • nicid - SK-NIC contact

Returns:
  • not_exists - contact doesn't exists
  • unknown - unknown answer from register
  • connect_error - pripojenie do registra bolo neuspesne
  • ok - command successful:
    • nicid - identificator in SK-NIC system
    • name - first name
    • org - business name
    • street - street
    • city - town
    • sp - province
    • pc - Postal code
    • cc - country
    • phone - phone
    • fax - fax
    • email - e-mail
    • registrar - registrar
backorder_domain_request($domain, $tld, $registrant)
Domain backorder.

Parameters:
  • domain - domain without TLD
  • tld - TLD
  • registrant - kontakt drzitela domeny

Returns:
  • no_perm - you don't have a permission for this action
  • not_ready - domain is not within 7 days period before deletion
  • exists - backorder of domain has already been ordered by other user
  • free - domain is not registered
  • not_exists - kontakt drzitela neexistuje
  • credit_low - credit low
  • ok - command successful:
    • id - Request ID
    • credit_balance - credit balance
get_backorders($poffset, $pcount, $fdomain=null, $fowner=null, $fstate=null)
List of backorders.

Parameters:
  • poffset - paging, offset
  • pcount - paging, number of items
  • fdomain - filter by domain without TLD
  • fowner - filter by SK-NIC ID of owner
  • fstate - filter by state

Returns:
  • ok - command successful:
    • count - number of all items
    • requests - array of requests:
      • id - Request ID
      • domain - domain without TLD
      • tld - TLD
      • registrant - registrant contact
      • dateadd - addition date, format DD.MM.YYYY
      • dateok - processing date, format DD.MM.YYYY
      • state - request state:
        • new - backorder has not been done yet
        • renewed - domain was renewed by its owner
        • reg - unsuccessful backorder
        • ok - successful backorder
get_backorder($request_id)
Information about backorder.

Parameters:
  • request_id - Request ID

Returns:
  • not_exists - request doesn't exist
  • ok - command successful:
    • domain - domain without TLD
    • tld - TLD
    • registrant - SK-NIC ID of owner
    • dateadd - addition date, format DD.MM.YYYY
    • dateok - processing date, format DD.MM.YYYY
    • state - request state:
      • new - backorder has not been done yet
      • renewed - domain was renewed by its owner
      • reg - unsuccessful backorder
      • ok - successful backorder
backorder_cancel($request_id)
Backorder cancellation.

Parameters:
  • request_id - Request ID

Returns:
  • not_exists - domain is not in backorder
  • cannot - backorder cannot be cancelled because domain is in state DOM_DEL or backorder has already been done
  • connect_error - pripojenie do registra bolo neuspesne
  • ok - command successful
get_requests($poffset, $pcount, $fid=null, $fdomain=null, $ftld=null, $ftype=null, $fstate=null)
List of requests.

Parameters:
  • poffset - paging, offset
  • pcount - paging, number of items
  • fid - filter by ID
  • fdomain - filter by domain without TLD
  • ftld - filter by TLD
  • ftype - filter by type
  • fstate - filter by state

Returns:
  • ok - command successful:
    • domain - domain without TLD [all except bulk requests]
    • tld - TLD [all except bulk requests]
    • dateadd - addition date and time format DD.MM.YYYY HH:MM:SS
    • dateok - datum a cas spracovania format DD.MM.YYYY HH:MM:SS
    • type - request type:
      • Same types as in get_request() function.
    • state - request state:
      • Same states as in get_request() function.
get_request($request_id)
Information about request.

Parameters:
  • request_id - Request ID

Returns:
  • not_exists - request doesn't exist
  • ok - command successful:
    • id - Request ID
    • dateadd - datum a cas prijatia format DD.MM.YYYY HH:MM:SS
    • dateok - datum a cas spracovania format DD.MM.YYYY HH:MM:SS
    • type - request type:
      • D - change of DNS servers
      • P - domain renewal
      • R - domain registration
      • T - transfer
      • RN - NSSet registration
      • RC - contact registration
      • MC - contact modification
      • MD - uprava domeny
    • state - request state:
      • new - request has not yet been processed
      • not_ready - domain is not ready for payment
      • inv_domain - invalid / not existing domain name
      • inv_state - domain is in a state in which it is impossible to complete your request [transfer]
      • not_exists - domain is on your account (this can happen only for domains using our local contact) [change of owner]
      • reg - domain is already registered [registration]
      • inv_ns - invalid DNS server [registration, change of DNS servers]
      • inv_ip - IP address of one of the DNS servers, which is the same as domain name, was not specified or is invalid [registration, change of DNS servers]
      • inv_ip2 - you have send IP address for one of the DNS servers which is not the same as domain name [registration, change od DNS servers]
      • processing - request si currently beeing processed (it is safe to ignore this state)
      • internal_error - internal error in our system (it is safe to ignore this state)
      • ok - success, more data is send only with this state
    • domain - domain without TLD
    • tld - TLD
expired_list()
List of expired domain. List is update every day from 13:30.

Returns:
  • ok - command successful:
    • domain - domain without TLD
    • date - domain deletion date, format DD.MM.YYYY
    • pagerank - Google PageRank
get_domains($poffset, $pcount, $fdomain=null, $ftld=null, $fexpirationfrom=null, $fexpirationto=null)
List of domains on your account.

Parameters:
  • poffset - paging, offset
  • pcount - paging, number of items
  • fdomain - filter by domain without TLD
  • ftld - filter by TLD
  • fexpirationfrom - filter by expire date (from)
  • fexpirationto - filter by expire date (to)

Returns:
  • ok - command successful:
    • count - number of all items
    • domains - domains:
      • domain - domain without TLD
      • tld - TLD
      • expiration - expire date, format DD.MM.YYYY
get_domain($domain, $tld)
Information about domain.

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

Returns:
  • not_exists - domain does not exist
  • ok - command successful:
    • id - domain ID
    • domain - domain without TLD
    • tld - TLD
    • expiration - expire date, format DD.MM.YYYY
    • notify - values:
      • 0 - notifikacie o exspiracii sa neodosielaju
      • 1 - notifikacie o exspiracii sa odosielaju
    • authid - AUTH-ID
poll_message()
Get oldest message from message queue.

Returns:
  • empty - message queue is empty
  • ok - command successful:
    • id - message ID
    • count - number of all items
    • message - message:
      • event - text of message:
        • OWNER CHANGED - domain changed its owner
        • DNS - change of DNS servers on domain
        • TRANSFERRED IN - domain was successfully transferred to our company
        • TRANSFERRED OUT - domain was transferred to another registrar
        • MOVED IN - domain was successfully transferred to you account from another user
        • MOVED OUT - domains was transferred to another user
        • OK - domain changed its state to DOM_OK (paid)
        • EXPIRED - domain changed its state to DOM_EXP (expired)
        • DELETED - domain changed its state to DOM_DEL (deleted) (will happen only for domains which uses our local contact)
      • domain - domain without TLD related to error (not required)
      • tld - TLD (not required)
ack_message($message_id)
Message deletion from message queue.

Parameters:
  • message_id - message ID

Returns:
  • not_exists - message doesn't exist
  • ok - command successful
get_waiting_payments($poffset, $pcount, $fdomain=null, $ftld=null, $ftype=null)
List of domains waiting for payment.

Parameters:
  • poffset - paging, offset
  • pcount - paging, number of items
  • fdomain - filter by domain without TLD
  • ftld - filter by TLD
  • ftype - filter by type

Returns:
  • ok - command successful:
    • id_domain - domain ID
    • domain - domain without TLD
    • tld - TLD
    • type - type of payment
    • expiration - expire date, format DD.MM.YYYY
get_domain_move_password($domain, $tld, $password)
Domain internal transfer password generator. Password is valid for 7 days and is deleted after successful internal transfer.

Parameters:
  • domain - domain without TLD
  • tld - TLD
  • password - password to Web Admin

Returns:
  • not_exists - domain does not exist
  • inv_password - invalid password
  • ok - command successful:
    • password - password for internal transfer
move_domain($domain, $tld, $password)
Internal transfer of domain from another user to your account.

Parameters:
  • domain - domain without TLD
  • tld - TLD
  • password - password for internal transfer

Returns:
  • inv_password - invalid password
  • ok - command successful:
    • id - domain ID
register_nsset_cz_request($name, $tech, $ns1, $ns2, $ns3=null, $ns4=null, $ip1=null, $ip2=null, $ip3=null, $ip4=null)
TODO

Parameters:

Returns:
create_contact_request($tld, $contacts)
Contact creation.

Parameters:
  • tld - values:
    • cz - contact for .cz domains
    • sk - contact for .sk domains
  • contacts - contacts:
    • registrant - owner:
      • regid - contact name
      • data - array of data:
        • name - first name
        • surname - last name
        • org - business name (not required)
        • street - street
        • city - town
        • pc - Postal code
        • sp - province (not required)
        • cc - country ISO code
        • phone - phone format +421 123456789
        • fax - fax (not required)
        • email - e-mail

Returns:
  • inv_tld - invalid parameter 'tld'
  • ok - command successful:
    • id - Request ID
modify_contact_request($cid, $contacts)
Modify contact.

Parameters:
  • cid - contact ID from our system
  • contacts - contacts:
    • registrant - owner:
      • data - array of data:
        • name - first name
        • surname - last name
        • org - business name (not required)
        • street - street
        • city - town
        • pc - Postal code
        • sp - province (not required)
        • cc - country ISO code
        • phone - phone format +421 123456789
        • fax - fax (not required)
        • email - e-mail

Returns:
  • not_exists - contact doesn't exists
  • ok - command successful:
    • id - Request ID
send_authid_cz($domain)
TODO

Parameters:

Returns:
create_domain_request($domain, $tld, $nss, $contacts)
Domain registration.

Parameters:
  • domain - domain without TLD
  • tld - TLD
  • nss - DNS servers:
    • nsset:
      • id - NSSet ID
    • hosts - array of DNS servers:
      • host - DNS server
      • ipv4 - IPv4 address of DNS server (glue record) (not required)
      • ipv6 - IPv6 address of DNS server (glue record) (not required)
  • contacts - contacts:
    • registrant - owner:
      • regid - contact name (if register supports it)
      • data - array of data:
        • name - first name
        • surname - last name
        • org - business name (not required)
        • street - street
        • city - town
        • pc - Postal code
        • sp - province (not required)
        • cc - country ISO code
        • phone - phone format +421 123456789
        • fax - fax (not required)
        • email - e-mail
    • admin - administrative contact:
      • regid - contact name (if register supports it)
      • data - array of data:
        • name - first name
        • surname - last name
        • org - business name (not required)
        • street - street
        • city - town
        • pc - Postal code
        • sp - province (not required)
        • cc - country ISO code
        • phone - phone format +421 123456789
        • fax - fax (not required)
        • email - e-mail
    • tech - technical contact:
      • regid - contact name (if register supports it)
      • data - array of data:
        • name - first name
        • surname - last name
        • org - business name (not required)
        • street - street
        • city - town
        • pc - Postal code
        • sp - province (not required)
        • cc - country ISO code
        • phone - phone format +421 123456789
        • fax - fax (not required)
        • email - e-mail
    • billing - billing contact:
      • regid - contact name (if register supports it)
      • data - array of data:
        • name - first name
        • surname - last name
        • org - business name (not required)
        • street - street
        • city - town
        • pc - Postal code
        • sp - province (not required)
        • cc - country ISO code
        • phone - phone format +421 123456789
        • fax - fax (not required)
        • email - e-mail

Returns:
  • inv_tld - invalid parameter 'tld'
  • invalid_registrant_contact - invalid registrant contact
  • invalid_tech_contact - invalid technical contact
  • invalid_admin_contact - invalid administrative contact
  • ok - command successful:
    • id - Request ID
renew_domain_request($domain, $tld)
Renewal of domain.

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

Returns:
  • inv_domain - domain does not exist
  • inv_tld - invalid parameter 'tld'
  • ok - command successful:
    • id - Request ID
modify_ns_request($domain, $tld, $nss)
Change of DNS servers.

Parameters:
  • domain - domain without TLD
  • tld - TLD
  • nss - DNS servers:
    • nsset:
      • id - NSSet ID
    • hosts - array of DNS servers:
      • host - DNS server
      • ipv4 - IPv4 address of DNS server (glue record) (not required)
      • ipv6 - IPv6 address of DNS server (glue record) (not required)

Returns:
  • inv_domain - domain does not exist
  • ok - command successful:
    • id - Request ID
modify_domain_request($domain, $tld, $contacts)
Uprava parametrov domeny.

Parameters:
  • domain - domain without TLD
  • tld - TLD
  • contacts - contacts:
    • registrant - owner:
      • regid - contact name (if register supports it)
      • data - array of data:
        • name - first name
        • surname - last name
        • org - business name (not required)
        • street - street
        • city - town
        • pc - Postal code
        • sp - province (not required)
        • cc - country ISO code
        • phone - phone format +421 123456789
        • fax - fax (not required)
        • email - e-mail

Returns:
  • inv_tld - invalid parameter 'tld'
  • inv_domain - domain does not exist
  • invalid_registrant_contact -
  • ok - command successful:
    • id - Request ID
transfer_domain_request($domain, $tld, $authid)
Zahajenie transferu domeny.

Parameters:
  • domain - domain without TLD
  • tld - TLD
  • authid - AUTH-ID code (not required)

Returns:
  • inv_tld - invalid parameter 'tld'
  • ok - command successful:
    • id - Request ID