RegisterDomain
کامندهای زیر برای ارسال درخواست ثبت دامنه به سرویس دهنده دامنه ارسال می شود.
Request Parameters
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
regperiod | Number | Yes | Registration period |
nameserver1 | String | No | First nameserver |
nameserver2 | String | No | Second nameserver |
nameserver3 | String | No | Third nameserver |
nameserver4 | String | No | Fourth nameserver |
nameserver5 | String | No | Fifth nameserver |
dnsmanagement | Number | No | Enables dns management for this domain |
emailforwarding | Number | No | Enables email forwarding for this domain |
idprotection | Number | No | Enables id protection for this domain |
firstname | String | Yes | First name of the user |
lastname | String | Yes | Last name of the user |
address1 | String | Yes | First part of user address |
address2 | String | No | Second part of user address |
city | String | Yes | City of the user |
state | String | Yes | State/Province of the user |
postcode | String | Yes | Postal/ZIP Code of the user |
country | String | Yes | Country of the user |
phonenumber | String | Yes | Phone number in the format +NNN.NNNNNNNNNN |
String | Yes | Email address of the user | |
adminfirstname | String | No | First name of the admin user |
adminlastname | String | No | Last name of the admin user |
adminaddress1 | String | No | First part of admin user address |
adminaddress2 | String | No | Second part of admin user address |
admincity | String | No | City of the admin user |
adminstate | String | No | State/Province of the admin user |
adminpostcode | String | No | Postal/ZIP Code of the admin user |
admincountry | String | No | Country of the admin user |
adminphonenumber | String | No | Phone number in the format +NNN.NNNNNNNNNN |
adminemail | String | No | Email address of the admin user |
domainfields | String | No | A base64 encoded serialized array of the TLD specific field values |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=RegisterDomain&sld=exampledomain&tld=com®period=1&nameserver1=ns1.yourdomain.com&nameserver2=ns2.yourdomain.com&firstname=test&lastname=test&companyname=company&address1=addresss&city=city&state=region&country=US&postcode=12345&phonenumber=1234567890&[email protected]' --compressed
نمونه پاسخ:
{"result":"success","msg":"Domain has been registered"}
کامندهای زیر برای ارسال درخواست انتقال دامنه به سرویس دهنده دامنه ارسال می شود.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
transfersecret | String | No | Domain authorization code |
regperiod | Number | Yes | Registration period |
nameserver1 | String | No | First nameserver |
nameserver2 | String | No | Second nameserver |
nameserver3 | String | No | Third nameserver |
nameserver4 | String | No | Fourth nameserver |
nameserver5 | String | No | Fifth nameserver |
dnsmanagement | Number | No | Enables dns management for this domain |
emailforwarding | Number | No | Enables email forwarding for this domain |
idprotection | Number | No | Enables id protection for this domain |
firstname | String | Yes | First name of the user |
lastname | String | Yes | Last name of the user |
address1 | String | Yes | First part of user address |
address2 | String | No | Second part of user address |
city | String | Yes | City of the user |
state | String | Yes | State/Province of the user |
postcode | String | Yes | Postal/ZIP Code of the user |
country | String | Yes | Country of the user |
phonenumber | String | Yes | Phone number in the format +NNN.NNNNNNNNNN |
String | Yes | Email address of the user | |
adminfirstname | String | No | First name of the admin user |
adminlastname | String | No | Last name of the admin user |
adminaddress1 | String | No | First part of admin user address |
adminaddress2 | String | No | Second part of admin user address |
admincity | String | No | City of the admin user |
adminstate | String | No | State/Province of the admin user |
adminpostcode | String | No | Postal/ZIP Code of the admin user |
admincountry | String | No | Country of the admin user |
adminphonenumber | String | No | Phone number in the format +NNN.NNNNNNNNNN |
adminemail | String | No | Email address of the admin user |
domainfields | String | No | A base64 encoded serialized array of the TLD specific field values |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=TransferDomain&sld=exampledomain&tld=com&transfersecret=gd23h231s21®period=1&nameserver1=ns1.yourdomain.com&nameserver2=ns2.yourdomain.com&firstname=test&lastname=test&companyname=company&address1=addresss&city=city&state=region&country=US&postcode=12345&phonenumber=1234567890&[email protected]' --compressed
نمونه پاسخ:
{"result":"success","msg":"Domain transfer initiated successfully."}
RenewDomain
کامندهای زیر برای ارسال درخواست تمدید دامنه به سرویس دهنده دامنه ارسال می شود.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
regperiod | Number | Yes | Registration period |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=RenewDomain&sld=exampledomain&tld=com®period=1' --compressed
نمونه پاسخ:
{"result":"success","msg":"The domain has been successfully."}
GetNameservers
کامندهای زیر برای دریافت نیم سرورهای دامنه استفاده می شود.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=GetNameservers&sld=exampledomain&tld=com' --compressed
نمونه پاسخ:
{"result":"success","ns1":"ns1.exampledomain.com","ns2":"ns2.exampledomain.com"}
SaveNameservers
کامندهای زیر برای بروزرسانی نیم سرورهای دامنه استفاده می شود.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
nameserver1 | String | No | First nameserver |
nameserver2 | String | No | Second nameserver |
nameserver3 | String | No | Third nameserver |
nameserver4 | String | No | Fourth nameserver |
nameserver5 | String | No | Fifth nameserver |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=SaveNameservers&sld=exampledomain&tld=com&ns1=ns1.exampledomain.com&ns2=ns2.exampledomain.com' --compressed
نمونه پاسخ:
{"result":"success"}
ReleaseDomain
کامندهای زیر برای ارسال درخواست آزادسازی دامنه به سرویس دهنده دامنه ارسال می شود.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
newtag | String | Yes | The new tag for the domain |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=ReleaseDomain&sld=exampledomain&tld=com&newtag=1AND1-TEST' --compressed
نمونه پاسخ:
{"result":"success"}
RequestDelete
این تابع زمانی فراخوانی می شود که درخواست حذف یک دامنه داده شود.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=RequestDelete&sld=exampledomain&tld=com' --compressed
نمونه پاسخ:
{"result":"success"}
GetEPPCode
کامندهای زیر برای دریافت کد EPP دامنه استفاده می شود.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=GetEPPCode&sld=exampledomain&tld=com' --compressed
نمونه پاسخ:
{"result":"success","eppcode":"23svxce123fds"}
GetContactDetails
کامند زیر اطلاعات whois یک دامنه خاص را ارائه می دهد.
پارامترهای درخواستName | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=GetContactDetails&sld=exampledomain&tld=com' --compressed
نمونه پاسخ:
{"result":"success","Registrant":{"Name":"John Doe","Company":"Company name","Address":"P.O.","City":"Amsterdam","Country":"NL","Zip_Code":"1001 GT","Email":"[email protected]","Telephone":"N\/A"}}
SaveContactDetails
کامندهای زیر برای بروزرسانی اطلاعات تماسی یک دامنه استفاده می شود.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
contactdetails | Array | Yes |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=SaveContactDetails&sld=exampledomain&tld=com&contactdetails[Registrant][Name]=John%20Doe&contactdetails[Registrant][Company]=Company%20name&contactdetails[Registrant][Address]=Address&contactdetails[Registrant][City]=Amsterdam&contactdetails[Registrant][Country]=NL&contactdetails[Registrant][Zip_Code]=1001 GT&contactdetails[Registrant][Email][email protected]&contactdetails[Registrant][Telephone]=N/A' --compressed
نمونه پاسخ:
{"result":"success","Registrant":{"Name":"John Doe","Company":"Company name","Address":"P.O.","City":"Amsterdam","Country":"NL","Zip_Code":"1001 GT","Email":"[email protected]","Telephone":"N\/A"}}
DomainGetLockingStatus
کامند زیر وضعیت قفل دامنه را نشان می دهد.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=domaingetlockingstatus&sld=exampledomain&tld=com' --compressed
نمونه پاسخ:
{"result":"success","lockstatus":"unlocked"}
DomainUpdateLockingStatus
کامندهای زیر برای بروزرسانی وضعیت قفل دامنه استفاده می شود.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
lockstatus | Null/Number | No | To lock the domain, set it to '1' |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=domainupdatelockingstatus&sld=exampledomain&tld=com&lockstatus=' --compressed
نمونه پاسخ:
{"result":"success"}
GetDNS
این تابع زمانی که شما از طریق WHMCS درخواست اطلاعات رکوردهای DNS دامنه را می دهید فراخوانی می شود.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=GetDNS&sld=exampledomain&tld=com' --compressed
نمونه پاسخ:
{"0":{"hostname":"*","type":"A","address":"0.0.0.0","priority":null},"1":{"hostname":"mail","type":"MXE","address":"0.0.0.0","priority":"10"},"result":"success"}
SaveDNS
این تابع زمانی که هر گونه تغییراتی روی اطلاعات رکوردهای DNS شما از طریق WHMCS انجام شود فراخوانی می شود.
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
dnsrecords | String | Yes | A base64 encoded serialized array of the dns records. |
base64_encode(serialize(array(0=>array("hostname"=>"*","type"=>"A","address"=>"0.0.0.0","priority"=>"N/A","recid"=>""))));; |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=SaveDNS&sld=exampledomain&tld=com&dnsrecords=czowOiIiOw==' --compressed
نمونه پاسخ:
{"result":"success"}
RegisterNameserver
این تابع زمانی که درخواست ثبت یک نیم سرور اختصاصی(child nameserver) می نمایید فراخوانی می شود.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
nameserver | String | Yes | |
ipaddress | String | Yes |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=RegisterNameserver&sld=exampledomain&tld=com&nameserver=test.exampledomain.com&ipaddress=1.1.1.1' --compressed
نمونه پاسخ:
{"result":"success"}
ModifyNameserver
این تابع زمانی که درخواست ویرایش نیم سرور اختصاصی(child nameserver) می نمایید فراخوانی می شود.
پارامترهای درخواست
Name | Type | Required? | Description | |
---|---|---|---|---|
sld | String | Yes | Domain name | |
tld | String | Yes | Suffix attached to domain name | |
nameserver | String | Yes | ||
currentipaddress | String | Yes | ||
newipaddress | String | Yes |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=ModifyNameserver&sld=exampledomain&tld=com&nameserver=test.exampledomain.com¤tipaddress=1.1.1.1&newipaddress=2.2.2.2' --compressed
نمونه پاسخ:
{"result":"success"}
DeleteNameserver
این تابع زمانی که درخواست حذف نیم سرور اختصاصی(child nameserver) را دارید فراخوانی می شود.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
nameserver | String | Yes |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=DeleteNameserver&sld=exampledomain&tld=com&nameserver=test.exampledomain.com' --compressed
نمونه پاسخ:
{"result":"success"}
GetEmailForwarding
این تابع زمانی که از طریق WHMCS درخواست مشاهده Email Forwarding را دارید فراخوانی می شود.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=GetEmailForwarding&sld=exampledomain&tld=com' --compressed
نمونه پاسخ:
{"1":{"prefix":"test","forwardto":"[email protected]"},"result":"success"}
SaveEmailForwarding
این تابع زمانی که از طریق WHMCS درخواست مشاهده Email Forwarding را دارید فراخوانی می شود.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
prefix | String | Yes | A base64 encoded serialized array of the prefixes. |
base64_encode(serialize(array(0=>"test")))); | |||
forwardto | String | Yes | A base64 encoded serialized array of the forwards. |
base64_encode(serialize(array(0=>"[email protected]"))); |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=SaveEmailForwarding&sld=exampledomain&tld=com&prefix=czowOiIiOw==&forwardto=czowOiIiOw==' --compressed
نمونه پاسخ:
{"result":"success"}
Sync
این تابع هماهنگسازی تمامی اطلاعات مربوط به تغییرات وضعیت دامنه,تمدیدات و تاریخ های انقضای دامنه را شامل می شود.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=Sync&sld=exampledomain&tld=com' --compressed
نمونه پاسخ:
{"result":"success"}
TransferSync
این تابع هر بار که cron مربوط به سنکرون سازی دامنه شما اجرا می شود برای هر دامنه ای که در وضعیت انتقال معلق" Pending Transfer" می باشد اجرا خواهد شد.
پارامترهای درخواست
Name | Type | Required? | Description |
---|---|---|---|
sld | String | Yes | Domain name |
tld | String | Yes | Suffix attached to domain name |
domain | String | Yes | Full domain name |
regperiod | Int | Yes | Registration period |
نمونه درخواست:
curl 'https://billing.pars.host/hosting/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=TransferSync&sld=exampledomain&tld=com&domain=exampledomain.com®period=1' --compressed
نمونه پاسخ:
{"result":"success"}