ثبت دامنه
این کامند جهت ثبت دامنه به مارال هاست ارسال می شود
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 |
email |
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://client.maralhost.com/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"}
انتقال دامنه :
این کامند جهت انتقال دامنه در مارال هاست از طریق API استفاده می گردد .
Request Parameters
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 |
email |
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://client.maralhost.com/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."}
تمدید دامنه
این کامند جهت تمدید دامنه مورد استفاده قرار می گیرد .
Request Parameters
Name | Type | Required? | Description |
sld |
String |
Yes |
Domain name |
tld |
String |
Yes |
Suffix attached to domain name |
regperiod |
Number |
Yes |
Registration period |
مثال ثبت درخواست:
curl 'https://client.maralhost.com/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."}
دریافت Name Server :
این کامند جهت دریافت Name Server های دامنه مورد استفاده قرار می گیرد
Request Parameters
Name | Type | Required? | Description |
sld |
String |
Yes |
Domain name |
tld |
String |
Yes |
Suffix attached to domain name |
مثال ارسال درخواست :
curl 'https://client.maralhost.com/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"}
ذخیره Name Server ها :
این کامند جهت بروز رسانی Name Server ها استفاده می شود
Request Parameters
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://client.maralhost.com/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"}
آزاد کردن دامنه
این کامند جهت آزاد کردن دامنه مورد استفاده قرار می گیرد :
Request Parameters
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://client.maralhost.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=ReleaseDomain&sld=exampledomain&tld=com&newtag=1AND1-TEST' --compressed
مثال دریافت پاسخ :
{"result":"success"}
درخواست حذف دامنه:
این تابع هنگامی فراخوانی می شود که شما قصد حذف دامنه را دارید .
Request Parameters
Name | Type | Required? | Description |
sld |
String |
Yes |
Domain name |
tld |
String |
Yes |
Suffix attached to domain name |
مثال ثبت درخواست :
curl 'https://client.maralhost.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=RequestDelete&sld=exampledomain&tld=com' --compressed
مثال دریافت پاسخ:
{"result":"success"}
دریافت کد انتقال:
این کامند جهت دریافت کد انتقال مورد استفاده قرار می گیرد
Request Parameters
Name | Type | Required? | Description |
sld |
String |
Yes |
Domain name |
tld |
String |
Yes |
Suffix attached to domain name |
مثال ارسال درخواست :
curl 'https://client.maralhost.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=GetEPPCode&sld=exampledomain&tld=com' --compressed
مثال دریافت پاسخ :
{"result":"success","eppcode":"23svxce123fds"}
دریافت اطلاعات تماس :
این کامند جهت دریافت اطلاعات تماس دامنه مورد استفاده قرار می گیرد
Request Parameters
Name | Type | Required? | Description |
sld |
String |
Yes |
Domain name |
tld |
String |
Yes |
Suffix attached to domain name |
مثال ثبت درخواست:
curl 'https://client.maralhost.com/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"}}
ذخیره سازی اطلاعات تماس دامنه :
این کامند جهت ویرایش و ذخیره سازی اطلاعات تماس دامنه مورد استفاده قرار می گیرد
Request Parameters
Name | Type | Required? | Description |
sld |
String |
Yes |
Domain name |
tld |
String |
Yes |
Suffix attached to domain name |
contactdetails |
Array |
Yes |
|
مثال ثبت درخواست:
curl 'https://client.maralhost.com/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"}}
دریافت اططلاعات قفل دامنه :
این کامند جهد دریافت اطلاعات وضعیت قفل دامنه استفاده می شود
Request Parameters
Name | Type | Required? | Description |
sld |
String |
Yes |
Domain name |
tld |
String |
Yes |
Suffix attached to domain name |
مثال ثبت درخواست :
curl 'https://client.maralhost.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=domaingetlockingstatus&sld=exampledomain&tld=com' --compressed
مثال دریافت پاسخ :
{"result":"success","lockstatus":"unlocked"}
ویرایش وضعیت قفل دامنه:
این کامند جهت بروزرسانی فقل دامنه مورد استفاده قرای می گیرد .
Request Parameters
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://client.maralhost.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=domainupdatelockingstatus&sld=exampledomain&tld=com&lockstatus=' --compressed
مثال دریافت پاسخ :
{"result":"success"}
دریافت DNS
این تابع جهت فراخوانی رکورد های دی ان اس مورد استفاده قرار می گیرد.
Request Parameters
Name | Type | Required? | Description |
sld |
String |
Yes |
Domain name |
tld |
String |
Yes |
Suffix attached to domain name |
مثال ثبت درخواست
curl 'https://client.maralhost.com/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"}
دخیره DNS
این تابع زمانی فراخوانی می شود که می خواهید هر گونه تغییری در رکورد های دی ان اس را ذخیره نمایید
Request Parameters
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://client.maralhost.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=SaveDNS&sld=exampledomain&tld=com&dnsrecords=czowOiIiOw==' --compressed
مثال دریافت پاسخ :
{"result":"success"}
ایجاد CHILD HOST
این تابع زمانی فراخوانی می شود که شما قصد ایجاد رکورد child Host دارید
Request Parameters
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://client.maralhost.com/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"}
ویرایش CHILD HOST
این متد زمانی فراخوانی می شود که شما قصد ویرایش CHILD HOST را دارید
Request Parameters
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://client.maralhost.com/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"}
حذف CHILD HOST
این پارامتر زمانی فراخوانی می شود که شما قصد حذف CHILD HOST را داشته باشید
Request Parameters
Name | Type | Required? | Description |
sld |
String |
Yes |
Domain name |
tld |
String |
Yes |
Suffix attached to domain name |
nameserver |
String |
Yes |
|
مثال ثبت درخواست
curl 'https://client.maralhost.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=DeleteNameserver&sld=exampledomain&tld=com&nameserver=test.exampledomain.com' --compressed
مثال دریافت پاسخ :
{"result":"success"}
دریافت EMAIL Forwarding
این پارامتر زمانی فراخوانی می شود که شما قصد مشاهده تنظیمات EMAIL FORWARDING را دارید
Request Parameters
Name | Type | Required? | Description |
sld |
String |
Yes |
Domain name |
tld |
String |
Yes |
Suffix attached to domain name |
مثال ثبت درخواست
curl 'https://client.maralhost.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=GetEmailForwarding&sld=exampledomain&tld=com' --compressed
مثال دریافت پاسخ
{"1":{"prefix":"test","forwardto":"[email protected]"},"result":"success"}
ذخیره تنظیمات EMAIL FORWARD
این متد جهت ذخیره EMAIL FORWARDING مورد استفاده قرار دهید
Request Parameters
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://client.maralhost.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=SaveEmailForwarding&sld=exampledomain&tld=com&prefix=czowOiIiOw==&forwardto=czowOiIiOw==' --compressed
مثال دریافت پاسخ :
{"result":"success"}
همگام سازی
این متد جهت همسان سازی تاریخ های ثبت ، انقضا و تمدید مورد استفاده قرار می گیرد .
Request Parameters
Name | Type | Required? | Description |
sld |
String |
Yes |
Domain name |
tld |
String |
Yes |
Suffix attached to domain name |
مثال ثبت درخواست :
curl 'https://client.maralhost.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=Sync&sld=exampledomain&tld=com' --compressed
مثال دریافت پاسخ:
{"result":"success"}
همگام سازی انتقال
این متد در هر باز اجرای CRON باعث بروز رسانی وضعیت دامنه های انتقال یافته با وضعیت در انتظار انتقال می باشد .
Request Parameters
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://client.maralhost.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=TransferSync&sld=exampledomain&tld=com&domain=exampledomain.com®period=1' --compressed
مثال دریافت پاسخ :
{"result":"success"}