PHP5 client library IV. - methods and functions of Joker module
Description of functions and classes ZMS module Joker (gTLD domains).
Contents
1. Common functions
login
System authorization
Input parameters:
- id_user - user name
- password - password
- remote_addr - clients IP address, for example:
$_SERVER['REMOTE_ADDR'];
2. Domain manipulation
Joker module contains this tlds : .com, .net, .info, .org, .biz, .cn, .us, .mobi, .name, .me, .hn, .vc, .ag, .lc, .sc, .bz, .mn.
domainCheck
Check of domain availability
Input parameters:
- domain_name - domain name
Output parameters:
- avail - 0 -> domain exist; 1 -> domain available
domainWhois
domain WHOIS (only domains under Joker.com administration)
Input parameters:
- domain_name - domain name
Output parameters:
- admin - admin contact id
- admin_email - admin contact e-mail
- billing - billing contact id
- billing_email - billing contact e-mail
- tech - technical contact id
- tech_email - technical contact e-mail
- expires - Expiration date
- nservers - nameservers (string of nameservers separated by a colon)
- registrar - registrar
- registrar_id - registrar id
- status - domain status (lock/production)
- created - domain creation date
- modified - date of last modification
- owner_full_name - owner name
- owner_title - Owner title
- owner_organization - owner organization
- owner_address_1 - owner address
- owner_address_2 - owner address
- owner_address_3 - owner address
- owner_city - owner city
- owner_postal_code - ZIP code
- owner_state - owner state
- owner_country - owner country
- owner_email - owner e-mail
domainCreate
Creation of new domain.
Input parameters:
- domain_name - domain name (with tld)
- period - 1 to 10 - number of years, for which domain is registred.
- owner - owner id (need to be created with same tld as domain)
- admin - admin contact id (need to be created with same tld as domain)
- tech - technical contact id (need to be created with same tld as domain)
- nameserver_1 - 1. nameserver
- nameserver_2 - 2. nameserver
domainRenew
Domain renew
Input parameters:
- domain_name - domain name (with tld)
- period - 1 to 10 - number of years, for which domain is prolonged
domainTransfer
Domain transfer
Input parameters:
- domain_name - Domain name
- nameserver_1 - 1. nameserver
- nameserver_2 - 2. nameserver
domainUpdateByPassword
Domain's adjustment by means of password
Input parameters:
- domain_name - domain name
- admin - admin contact id (need to be created with same tld as domain)
- tech - technical contact id (need to be created with same tld as domain)
- nameserver_1 - 1. nameserver
- nameserver_2 - 2. nameserver
- nameserver_3 - 3. nameserver
- contact_email - owner e-mail
- password - time-restricted password sent at contact_email
- respond_to - any e-mail address, where will be the result sent
domainLockByPassword
Domain lock using password.
Input parameters:
- domain_name - domain name
- contact_email - owner e-mail
- password - time-restricted password sent at contact_email
- respond_to - any e-mail address, where will be the result sent
domainUnlockByPassword
Domain unlock using password.
Input parameters:
- domain_name - domain name
- contact_email - owner e-mail
- password - time-restricted password sent at contact_email
- respond_to - any e-mail address, where will be the result sent
domainSendAuthIdByPassword
Sending of AuthInfo domain
Input parameters:
- domain_name - domain name
- contact_email - owner e-mail
- password - time-restricted password sent at contact_email
3. Contact manipulation
contactWhois
contact WHOIS(only contacts under Joker.com management).
Input parameters:
- id - contact id
Output parameters:
- full_name - contact name/li>
- title - contact title
- organization - organization
- address_1 - address
- address_2 - address
- address_3 - address
- city - city
- postal_code - ZIP code
- state - state
- country - country
- email - e-mail
- fax - fax number
- phone - phone number
- created - contact creation date
- modified - last modified date
contactCreate
Contact creation.
Input parameters:
- tld - tld of new contact (com, net, info, org, biz, cn, us, mobi, name, me, hn, vc, ag, lc, sc, bz, mn)
- full_name - contact name
- title - contact title
- organization - organization
- address_1 - address
- address_2 - address
- address_3 - address
- city - city
- postal_code - ZIP code
- state - state
- country - country
- email - e-mail
- phone - phone number
- fax - fax number
- respond_to - e-mail address, where will be the result sent (id of new contact will be also sent here!)
contactUpdateByPassword
Contact data update using password
Input parameters:
- id - contact id
- full_name - contact name
- title - contact title
- organization - organization
- address_1 - address
- address_2 - address
- address_3 - address
- city - city
- postal_code - ZIP code
- state - state
- country - country
- email - e-mail
- phone - phone number
- fax - fax number
- password - time-restricted password sent at contact_email
- respond_to - e-mail address, where will be the result sent
contactSendPassword
Forward a temporary password for contact (necessary for domain update, lock/unlock, sending auth-info, and contact update).
Input parameters:
- contact_email - contact e-mail
- expire_in_days - number of days for password validity
