سؤالات متداول NiceNIC Domain API نسخه ۲
پاسخهای کاربردی درباره دسترسی به API، آزمایش در Sandbox، احراز هویت، قیمتگذاری، عملیات دامنه، مدیریت پاسخها و اتصال به محیط تولید بیابید.
شروع کار
با دسترسی، قیمتگذاری و اعتبارنامهها شروع کنید.
01 NiceNIC Domain API v2 چیست؟
NiceNIC Domain API v2 یک API مبتنی بر HTTPS و JSON برای خودکارسازی مدیریت دامنه از طریق حساب NiceNIC شما است.
از گردشهای کاری اصلی شامل بررسی موجود بودن دامنه، ثبت، تمدید، انتقال، جستجوی پرتفوی، بهروزرسانی نامسرور و اطلاعات تماس، قیمتگذاری، رکوردهای DNS، نامسرورهای فرزند، اطلاعات حساب و عملیات مرتبط با انطباق پشتیبانی میکند.
هنگامی که میخواهید خدمات دامنه NiceNIC را مستقیماً به یک وبسایت، پلتفرم میزبانی، سیستم صورتحساب، ابزار داخلی یا برنامه دیگر متصل کنید، از API استفاده کنید.
02 چه کسی میتواند از NiceNIC Domain API v2 استفاده کند؟
هر حساب فعال NiceNIC میتواند از Domain API v2 استفاده کند. دسترسی API برای حسابهای بازار و حسابهای فروشنده در دسترس است.
برای دریافت دسترسی API نیازی به تبدیل شدن به یک فروشنده نیست. نوع حساب همچنان برای قیمتگذاری مهم است: عملیات API پولی از قیمتگذاری اختصاصدادهشده به حساب NiceNIC که درخواست را ارسال میکند استفاده میکنند.
03 آیا NiceNIC Domain API v2 رایگان است؟
بله، دسترسی به API خود رایگان است. هیچ هزینه جداگانهای برای فعالسازی دسترسی API یا ارسال درخواستهای پشتیبانیشده API دریافت نمیشود.
عملیات پولی مانند ثبت، تمدید و انتقال دامنه بر اساس قیمتگذاری حساب شما و قوانین مربوط به دامنه محاسبه میشود.
۰۴ آیا برای استفاده از API به حساب Reseller نیاز دارم؟
خیر. دسترسی API و قیمتگذاری reseller دو موضوع جداگانه هستند.
شما میتوانید از Domain API v2 با یک حساب عادی NiceNIC Market استفاده کنید. تنها زمانی به Reseller Account ارتقا دهید که قیمتگذاری reseller یا سایر مزایای reseller برای حجم کسبوکار شما مفید باشد.
۰۵ API v2 چه تفاوتی با API قدیمی NiceNIC دارد؟
Domain API v2 از ساختار فعلی API NiceNIC با درخواستهای HTTPS، پاسخهای JSON، احراز هویت مبتنی بر هدر و مستندات سازمانیافته بر اساس گردشکارهای دامنه و حساب استفاده میکند.
اگر یکپارچهسازی مبتنی بر API قدیمی NiceNIC را نگهداری میکنید، قبل از انتقال ترافیک تولید، پارامترهای API v2 و نحوه مدیریت پاسخها را بررسی کنید و فرض نکنید که دو نسخه قابل جایگزینی هستند.
۰۶ چگونه اعتبارنامه API خود را دریافت کنم؟
به حساب NiceNIC خود وارد شوید و تنظیمات API را باز کنید. درخواستهای API v2 از نام کاربری NiceNIC و API Secret شما برای احراز هویت استفاده میکنند.
محیط آزمایشی و احراز هویت
اتصال امن و آزمایش پیش از تولید.
۰۷ آیا NiceNIC Domain API v2 محیط آزمایشی API فراهم میکند؟
بله. NiceNIC یک محیط آزمایشی API برای توسعهدهندگان فراهم میکند تا پیش از اتصال به API تولید، یکپارچهسازیها را آزمایش کنند.
پیش از فعالسازی عملیات زنده دامنه مشتری، از محیط آزمایشی برای اعتبارسنجی احراز هویت، قالببندی درخواست، تجزیه پاسخ، مدیریت خطا و گردش کار برنامه خود استفاده کنید.
۰۸ تفاوت بین محیط آزمایشی و API تولید چیست؟
محیط آزمایشی API برای توسعه و تست یکپارچهسازی در نظر گرفته شده است. API تولید برای عملیات زنده دامنه و درخواستهای پرداختی علیه حساب NiceNIC شما استفاده میشود.
توصیه میکنیم پیش از فعالسازی عملیات تولید رو به مشتری، احراز هویت، مدیریت درخواست، پردازش پاسخ و منطق خطا را در محیط آزمایشی اعتبارسنجی کنید.
۰۹ احراز هویت API چگونه کار میکند؟
درخواستهای API را از طریق HTTPS ارسال کنید و نام کاربری NiceNIC و رمز API خود را در هدر Authorization قرار دهید.
Host: api.nicenic.net
Authorization: username:api_secret
Content-Type: application/json
اگر محدودیت IP برای حساب شما فعال باشد، درخواستها باید از یک آدرس IP مجاز سرور ارسال شوند.
10 Domain API نسخه ۲ از چه endpoint استفاده میکند؟
آدرس پایه Production API عبارت است از:
https://api.nicenic.net/v2/
عملیات API با استفاده از پارامترهای مستندشده برای هر endpoint انتخاب میشوند، مانند category و action. همیشه برای پارامترهای الزامی و اختیاری هر عملیات خاص، از مستندات اختصاصی همان endpoint پیروی کنید.
11 فرمت پاسخ و رمزگذاری کاراکتر در API نسخه ۲ چگونه است؟
پاسخهای API نسخه ۲ از JSON و پارامترهای درخواست از UTF-8 استفاده میکنند.
{
"code": 0,
"msg": "success",
"data": {}
}
برنامه شما باید code و msg بازگشتی را بررسی کند، نه اینکه فرض کند هر پاسخ HTTP به معنای تکمیل عملیات دامنه است.
عملیات دامنه و قیمتگذاری
با گردش کارهای پشتیبانیشده و رفتار خرید آشنا شوید.
12 با NiceNIC API دامنه v2 چه کارهایی میتوانم انجام دهم؟
از طریق APIهای مستندشدهی فعلی میتوانید گردشهای کاری خودکار شامل بررسی در دسترس بودن دامنه، ثبت، تمدید و انتقال، فهرست پورتفولیو و جزئیات دامنه، بهروزرسانی سرورهای نام و اطلاعات تماس دامنه، قیمتگذاری دامنه، رکوردهای DNS، سرورهای نام فرزند، اطلاعات حساب و نظارت بر سوءاستفاده و انطباق را انجام دهید.
گردشهای کاری اضافی بهطور جداگانه در ناوبری API مستند شدهاند.
13 قبل از فعالسازی ثبت یا انتقال واقعی چه چیزی را باید آزمایش کنم؟
با عملیات خواندنی کمریسک مانند بررسی در دسترس بودن دامنه، قیمتگذاری دامنه، موجودی حساب و فهرست دامنهها شروع کنید.
سپس قبل از فعالسازی ثبت، تمدید یا انتقال واقعی، احراز هویت، تجزیه و تحلیل پاسخ، مدیریت خطا و مدیریت سفارشهای در انتظار را تأیید کنید.
14 آیا میتوانم چندین دامنه را در یک درخواست API بررسی کنم؟
بله. نقطه پایانی بررسی در دسترس بودن دامنه از چند نام دامنه جدا شده با ویرگول پشتیبانی میکند.
example.com,example.net,example.org
فرض نکنید که هر عملیات API از همان فرمت ورودی چند دامنه پشتیبانی میکند. ثبت، تمدید و انتقال باید از مستندات نقطه پایانی مربوطه پیروی کنند.
15 چگونه میتوانم قیمتهای ثبت، تمدید و انتقال را جستجو کنم؟
از endpoint Get Domain Pricing استفاده کنید. انواع قیمتگذاری مستند شامل register، renew، transfer و all هستند.
پاسخهای ثبت میتوانند همچنین شامل مقدار is_premium باشند که نشان میدهد آیا ثبت مورد نظر premium است.
از آنجا که سفارشهای API از قیمتگذاری سطح حساب استفاده میکنند، قبل از ارسال سفارشهای پولی مشتری، قیمت فعلی را استعلام کنید و به طور نامحدود به قیمتهای کششده اتکا نکنید.
16 آیا میتوان هر TLD را به مدت ۱–۱۰ سال ثبت یا تمدید کرد؟
خیر. اگرچه مستندات API از دورههای حداکثر ۱–۱۰ سال برای پسوندهای قابلاعمال پشتیبانی میکنند، اما هر TLD ممکن است قوانین ثبت متفاوتی داشته باشد.
دورههای ثبت، دورههای تمدید، شرایط انتقال، الزامات تماس و الزامات تأیید میتوانند بسته به پسوند متفاوت باشند. برنامه شما باید قوانین جاری مربوط به TLD مورد نظر را دنبال کند.
17 تفاوت بین Nameservers، DNS Records و Child Nameservers چیست؟
ns1.example.com ایجاد میکنند.این عملیاتها از یکدیگر جدا هستند و نباید به عنوان معادل یکدیگر در نظر گرفته شوند.
پاسخها و خطاها
حالتهای موفق، در انتظار و شکست را به درستی مدیریت کنید.
18 کدهای پاسخ API به چه معنا هستند؟
| کد | معنی |
|---|---|
0 | موفق |
201 | در انتظار |
400 | خطای پارامتر |
401 | غیرمجاز |
404 | هیچ رکورد مرتبطی یافت نشد |
500 | خطای داخلی سرور |
هنگام تعیین وضعیت یک درخواست API، همیشه از کد و پیام بازگرداندهشده استفاده کنید.
۱۹ کد 201 به چه معناست؟
پاسخ 201 به این معنی است که عملیات برای پردازش پذیرفته شده است، اما لزوماً به وضعیت نهایی نرسیده است.
۲۰ وقتی ثبت دامنه کد 201 برمیگرداند چه اتفاقی میافتد؟
برای ثبت دامنه، پاسخ 201 نشان میدهد که سفارش ارسال شده و در انتظار پردازش نهایی ثبتکننده (registry) است.
تا زمانی که سیستم شما نتیجه نهایی را تأیید نکرده است، به مشتری نهایی نگویید که دامنه فعال است. برای جدیدترین قوانین مربوط به سفارشهای در انتظار و رسیدگی به بازپرداخت، مستندات endpoint ثبت را دنبال کنید.
۲۱ پاسخ انتقال در انتظار (Pending transfer) به چه معناست؟
انتقال در انتظار به این معنی است که درخواست انتقال برای پردازش پذیرفته شده است، نه اینکه دامنه قبلاً انتقال خود را به NiceNIC تکمیل کرده باشد.
تکمیل انتقال ممکن است به پردازش ثبتکننده (registry) و ثبتکننده (registrar) و همچنین وضعیت فعلی انتقال دامنه بستگی داشته باشد. انتقال را در وضعیت در انتظار نگه دارید تا تکمیل آن تأیید شود.
پورتفوی، انطباق و یکپارچهسازی
پورتفویها را مدیریت کنید و سیستمهای موجود را متصل کنید.
22 آیا میتوانم پورتفوی دامنه خود را از طریق API بازیابی و فیلتر کنم؟
بله. API List Domains از بازیابی پورتفوی با گزینههای صفحهبندی، مرتبسازی و فیلتر پشتیبانی میکند.
هنگامی که به اطلاعات دقیق برای یک دامنه خاص نیاز دارید، مانند اطلاعات ثبت، اطلاعات انقضا، سرورهای نام و دادههای تماس دامنه، از Get Domain Details استفاده کنید.
23 API Abuse & Compliance چه کاری میتواند انجام دهد؟
NiceNIC Domain API v2 شامل عملیات Abuse & Compliance است که برای پلتفرمها و فروشندگان مدیریت پورتفوی دامنه مشتریان طراحی شده است.
شما میتوانید دامنههای مرتبط با گزارشهای سوءاستفاده را شناسایی کرده و اطلاعات انطباق قابل خواندن توسط ماشین را برای دامنههای فردی بازیابی کنید. بسته به مورد، پاسخ میتواند شامل وضعیت دامنه، تأثیر فعلی، اقدام پیشنهادی، اطلاعات نگهداری، اطلاعات شکایت و URLهای گزارششده باشد.
این امر امکان نمایش مستقیم وضعیت انطباق را در پورتال مشتری یا سیستم عملیاتی خود شما فراهم میکند.
24 آیا میتوانم از NiceNIC Domain API v2 با WHMCS استفاده کنم؟
بله. NiceNIC یکپارچهسازی رجیسترار WHMCS را برای کسبوکارهایی که قبلاً از WHMCS برای صدور صورتحساب و تأمین خدمات استفاده میکنند، فراهم میکند.
هنگامی که در حال ساخت برنامه یا گردش کار شخصی خود هستید، از Domain API نسخه ۲ به صورت مستقیم استفاده کنید. زمانی که میخواهید عملیات دامنه در محیط WHMCS موجود یکپارچه شود، از یکپارچهسازی WHMCS بهره ببرید.
توسعه و پشتیبانی
با خیال راحت بسازید و بدانید هنگام نیاز به کمک چه چیزی ارسال کنید.
25 از چه زبانهای برنامهنویسی میتوانم استفاده کنم؟
هر زبان برنامهنویسی سمت سرور یا محیط اجرایی که بتواند درخواستهای HTTPS ارسال کرده و JSON را تجزیه کند، میتواند با Domain API v2 یکپارچه شود.
انتخابهای رایج شامل PHP، Python، Node.js و Java هستند. اعتبارنامههای API را در سمت سرور نگه دارید و هرگز API Secret خود را در جاوااسکریپت سمت مرورگر یا کد کلاینت قابل دانلود قرار ندهید.
26 آیا محدودیت نرخ درخواست API وجود دارد؟
برای محافظت از پایداری API و امنیت پلتفرم، ممکن است محدودیت نرخ اعمال شود.
اگر انتظار میرود یکپارچهسازی تولیدی شما حجم بالایی از درخواستهای مداوم را ایجاد کند، قبل از راهاندازی با NiceNIC تماس بگیرید تا الگوی استفاده مورد انتظار شما بررسی شود.
27 هنگام تماس با پشتیبانی درباره مشکل API چه مواردی را باید ارائه دهم؟
شامل زمانبرچسب درخواست، دسته و عملکرد API، نام دامنه در صورت وجود، پارامترهای غیرحساس درخواست، کد و پیام پاسخ برگشتی و همچنین اینکه درخواست از محیط آزمایشی (Sandbox) یا محیط تولید (Production) ارسال شده باشد.
28 پارامترهای کامل درخواست و نمونه کدها را کجا میتوانم پیدا کنم؟
از ناوبری API در مستندات استفاده کنید. هر عملیات صفحه مخصوص به خود را برای پارامترهای پشتیبانیشده، نمونه درخواست، نمونه پاسخ و رفتار خاص آن عملیات دارد.
این بخش سوالات متداول رفتار کلی API را توضیح میدهد؛ مستندات هر نقطه پایانی (Endpoint) بهعنوان منبع معتبر برای قالب دقیق درخواست در نظر گرفته شود.
آماده شروع ساختن هستید؟
یکپارچهسازی خود را در API Sandbox آزمایش کنید و سپس وقتی آماده رفتن به محیط تولید شدید، حساب NiceNIC خود را متصل کنید.
برای حجم بالای دامنه به قیمتگذاری فروش مجدد نیاز دارید؟
مقایسه پلنهای Reseller ←






