آزمایشگاه توسعه‌دهندگان

مرکز توسعه و مستندات API سرویس Domain123

ابزارهای توسعه Domain123

تمام ابزارهای مورد نیاز برای اتصال نرم‌افزار، وب‌سایت یا سامانه ثبت دامنه شما به سرویس Domain123 در این بخش قرار گرفته است.

ماژول رسمی WHMCS

راهکار آماده برای اتصال WHMCS به Domain123.

نسخه2.0 سازگار با WHMCS8.x PHP7.4+
  • ثبت دامنه
  • تمدید دامنه
  • انتقال دامنه
  • مدیریت DNS
  • Registrar Lock
  • همگام‌سازی خودکار تاریخ انقضا
  • نمایش اطلاعات دامنه در WHMCS

REST API

تمام سرویس‌های Domain123 از طریق REST API در دسترس هستند و پاسخ‌ها با فرمت JSON بازگردانده می‌شوند.

آدرس پایه سرویسhttp://cp.domain123.ir/api/

نسخه API: 2.0

احراز هویت

تمام درخواست‌ها باید دارای Header زیر باشند:

Authorization: Bearer YOUR_API_TOKEN

توکن API را می‌توانید پس از ورود به پنل کاربری از بخش وب‌سرویس دریافت کنید.

نمونه ثبت دامنه

نمونه درخواست PHP برای ثبت دامنه از طریق REST API:

PHP — domains/register<?php

$token = "dsgflgcxbdsufd98749534nfvfv-gdfigjdfvvf3625f3f6gvkfdkfvnfkvnkfnvnffkgldfjgldfvlmfdvlkfdv";
$url = 'https://cp.domain123.ir/api/domains/register';

$data = array(
    'domain_name' => 'example.ir',
    'handle_holder' => 'am123-irnic',
    'handle' => 'am123-irnic',
    'domain_period' => 1,
    'Conditions' => 1,
    'dns_1' => 'dns1.mrservers.net',
    'dns_2' => 'dns2.mrservers.net',
    'dns_3' => 'dns3.mrservers.net',
    'dns_4' => null,
);

$data_Authorization = array(
    'Accept: application/json',
    'Authorization: Bearer ' . $token,
);

$fields_tools = http_build_query($data);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $fields_tools);
curl_setopt($ch, CURLOPT_HTTPHEADER, $data_Authorization);

$result = curl_exec($ch);
curl_close($ch);

var_dump($result);
?>

پارامترهای درخواست

پارامتر توضیح
token توکن API
domain_name نام دامنه
handle_holder شناسه ایرنیک مالک دامنه
handle شناسه ایرنیک (در صورت نیاز برابر با handle_holder)
domain_period مدت ثبت (۱ یا ۵ سال)
Conditions پذیرش قوانین (همیشه مقدار ۱)
dns_1 تا dns_4 نیم‌سرورها (اختیاری)

پاسخ موفق

در صورت موفقیت‌آمیز بودن عملیات، پاسخ زیر بازگردانده می‌شود:

{
  "success": true,
  "code": 1000
}

پاسخ خطا

در صورت بروز خطا، کدی به‌جز ۱۰۰۰ برگشت داده می‌شود و متن خطا در فیلد message نمایش داده خواهد شد.

{
  "error": true,
  "message": "...",
  "code": ...
}

سایر Endpoint ها

به‌جای فقط ثبت دامنه، تمام APIهای موجود در ماژول رسمی معرفی شده‌اند:

POST
/domains/register

ثبت دامنه

POST
/domains/renew

تمدید دامنه

POST
/domains/transfer

انتقال دامنه

POST
/domains/info

اطلاعات دامنه

POST
/domains/dns

مدیریت نیم‌سرورها

POST
/domains/lock

فعال یا غیرفعال کردن Registrar Lock

POST
/domains/lockStatus

وضعیت Registrar Lock

این Endpointها مستقیماً از ماژول رسمی WHMCS استخراج شده‌اند.

امکانات API

به‌صورت خلاصه، API از قابلیت‌های زیر پشتیبانی می‌کند:

ثبت دامنه
تمدید دامنه
انتقال دامنه
مدیریت نیم‌سرورها
دریافت اطلاعات دامنه
Registrar Lock
همگام‌سازی وضعیت و تاریخ انقضا
پاسخ‌های JSON
احراز هویت با Bearer Token