نمای کلی API

مستندات NiceNIC Domain API v2 و شروع سریع

NiceNIC Domain API v2 برای حساب‌های Market و حساب‌های Reseller در دسترس است. از این مرور کلی برای پیکربندی دسترسی، تأیید اولین درخواست خود، درک مدل پاسخ API و رفتن مستقیم به بخش مربوطه در ناوبری سمت چپ استفاده کنید.

دسترسی API و قیمت‌گذاری reseller جداگانه هستند.
حساب Market: دسترسی API با قیمت‌گذاری حساب Market.
حساب Reseller: دسترسی API با قیمت‌گذاری اختصاص‌یافته به سطح فعلی reseller.
مقایسه سطوح و قیمت‌گذاری reseller ←

فعال‌سازی دسترسی API مشاهده مستندات API

آدرس پایه

https://api.nicenic.net/v2/

هدرهای الزامی

Host: api.nicenic.net Authorization: username:api_secret Content-Type: application/json

پاسخ استاندارد موفقیت

{ "code": 0, "msg": "success", "data": {} }

محیط آزمایشی API

یکپارچه‌سازی خود را قبل از راه‌اندازی آزمایش کنید

قبل از انتقال به محیط تولید، از NiceNIC API Sandbox برای آزمایش یکپارچه‌سازی Domain API خود استفاده کنید. احراز هویت، درخواست‌های API، مدیریت پاسخ‌ها و جریان کار برنامه خود را در یک محیط آزمایشی اختصاصی اعتبارسنجی کنید.

ایده‌آل برای فروشندگان، ارائه‌دهندگان میزبانی، توسعه‌دهندگان و پلتفرم‌هایی که برای یکپارچه‌سازی API آماده می‌شوند.

کاوش در محیط آزمایشی API ←

شروع سریع

اولین فراخوانی API خود را در ۴ مرحله انجام دهید

قبل از فعال‌سازی ثبت‌نام‌ها، تمدیدها یا انتقال‌های زنده، با یک درخواست فقط‌خواندنی شروع کنید. این کار به شما امکان می‌دهد تا احراز هویت، قالب‌بندی درخواست و مدیریت پاسخ را بدون ثبت سفارش پولی اعتبارسنجی کنید.

1

فعال‌سازی دسترسی API

تنظیمات API را باز کنید، کلید API را ایجاد یا بازیابی کنید، و در صورت نیاز، آدرس‌های IP سرور مجاز را پیکربندی کنید.

2

تأیید احراز هویت

از HTTPS با هدر Authorization در قالب username:api_secret استفاده کنید.

3

اجرای یک تست امن

با بررسی در دسترس بودن دامنه، قیمت‌گذاری، موجودی حساب یا فهرست دامنه‌ها شروع کنید.

4

پردازش پاسخ

قبل از فعال‌سازی عملیات تولیدی پولی، code و msg بازگردانده‌شده را بخوانید و ذخیره کنید.

درخواست پیشنهادی اول: بررسی موجود بودن دامنه

خط پایانه بررسی موجود بودن، با جدا کردن نام دامنه‌ها با ویرگول، از چند دامنه در یک درخواست پشتیبانی می‌کند.

curl "https://api.nicenic.net/v2/?category=domain&action=check&domains=example.com,example.net" \ -H "Authorization: username:api_secret" \ -H "Content-Type: application/json"

مشاهده بررسی موجود بودن دامنه مشاهده API قیمت دامنه

نقشه API

گردش کار مورد نیاز خود را انتخاب کنید

نمای کلی زیر با ناوبری سمت چپ مطابقت دارد. از آن برای شناسایی گردش کار صحیح استفاده کنید، سپس صفحه نقطه پایان مربوطه را برای پارامترها، نمونه‌های درخواست و نمونه‌های پاسخ باز کنید.

بخش	کاربرد آن	عملکردهای مستند
شروع کار	به‌صورت امن متصل شوید و نحوه مدیریت پاسخ‌ها را درک کنید.	نمای کلی API، محیط آزمایشی API، احراز هویت، کدهای پاسخ.
مدیریت دامنه	چرخه حیات اصلی دامنه را خودکار کنید.	در دسترس بودن، فهرست دامنه‌ها، جزئیات دامنه، ثبت، تمدید، انتقال ورودی، سرورهای نام، مخاطبین، قیمت‌گذاری.
سوءاستفاده و انطباق	دامنه‌هایی را که نیاز به توجه به انطباق دارند نظارت کنید.	فهرست دامنه‌های دارای گزارش سوءاستفاده و دریافت وضعیت سوءاستفاده قابل خواندن توسط ماشین، چرخه حیات تعلیق، اطلاعات شکایت و اقدام توصیه‌شده.
رکوردهای DNS	رکوردهای DNS میزبانی‌شده را به‌صورت برنامه‌نویسی مدیریت کنید.	فهرست‌سازی، ایجاد، به‌روزرسانی و حذف رکوردهای DNS.
نامسرورهای فرزند	مدیریت رکوردهای host / glue برای سرورهای نام در دامنه خودتان.	ایجاد، فهرست‌سازی، به‌روزرسانی و حذف سرورهای نام فرزند.
حساب و صورتحساب	اتصال اتوماسیون به بررسی‌های سطح حساب.	موجودی حساب و اطلاعات حساب مرتبط با تراکنش‌ها.
WHMCS API	یکپارچه‌سازی NiceNIC با جریان کاری صورتحساب‌دهی WHMCS موجود.	در دسترس بودن، ثبت، تمدید، انتقال، جزئیات دامنه، سرورهای نام، مخاطبین و سایر عملکردهای ماژول ثبت‌کننده.
سوالات متداول API	حل سوالات رایج در مورد دسترسی، امنیت، آزمایش و جریان کار.	شرایط احراز هویت، اعتبارنامه‌ها، پردازش درخواست، عملیات پشتیبانی‌شده و راهنمای یکپارچه‌سازی.

جریان کاری پیشنهادی

ترتیب پیشنهادی برای یکپارچهسازی اول

یک یکپارچهسازی تولیدی قابل اعتماد باید پیش از ارسال سفارشهای واقعی مشتری، شرایط دسترسی و خرید را اعتبارسنجی کند.

۱. احراز هویت
API Secret + IP مجاز

→

۲. بررسی موجودیت
تست اتصال فقطخواندنی

→

۳. قیمتگذاری
استعلام هزینه سطح حساب جاری

→

۴. موجودی
تأیید موجودی برای عملیات پولی

→

۵. مدیریت پاسخ
پردازش کد + پیام

→

۶. عملیات زنده
ثبت / تمدید / انتقال

تصور نکنید درخواست API صرفاً به دلیل پذیرفتهشدن کامل شده است. برخی عملیات ممکن است وضعیت «در انتظار» بازگردانند و همچنان به پردازش ثبت (registry) نیاز داشته باشند تا وضعیت نهایی دامنه تأیید شود.

رفتار در محیط تولید

درک پاسخ‌های موفق، در انتظار و خطا

code: 0 — پاسخ موفق نمونه‌های فعلی endpoint برای پاسخ‌های موفق تکمیل‌شده از کد 0 استفاده می‌کنند.

code: 201 — سفارش در انتظار مستندات ثبت و انتقال می‌توانند زمانی که سفارشی ارسال شده اما پردازش نهایی هنوز در انتظار است، کد 201 را بازگردانند.

code: 400 — خطای درخواست نمونه‌های endpoint برای خطاهای پارامتر درخواست از کد 400 استفاده می‌کنند.

رفتار انتظار برای ثبت

برای ثبت دامنه، مستندات فعلی بیان می‌کنند که پاسخ 201 به معنای ارسال موفق سفارش و کسر هزینه است، اما فعال‌سازی نهایی همچنان منوط به تأیید ثبت‌کننده است. اگر دامنه قابل فعال‌سازی نباشد، هزینه ثبت ظرف ۲۴ ساعت به موجودی حساب NiceNIC بازگردانده می‌شود.

رفتار در انتظار انتقال

نقطه پایانی انتقال همچنین 201 را به عنوان سفارش در انتظار ثبت می‌کند. بنابراین برنامه شما باید انتقال در انتظار را به عنوان پذیرش برای پردازش در نظر بگیرد، نه به عنوان اثبات اینکه انتقال قبلاً تکمیل شده است.

مستندات ثبت دامنه مستندات انتقال دامنه

قیمت‌گذاری

استعلام قیمت پیش از عملیات پولی

نقطه دسترسی قیمت‌گذاری NiceNIC می‌تواند قیمت ثبت، تمدید و انتقال یک دامنه را بازیابی کند. مقادیر مستند برای type عبارتند از register، renew، transfer و all. دوره مستند از ۱ تا ۱۰ سال است، با امکان استثناهای خاص برای هر TLD.

پاسخ‌های قیمت‌گذاری ثبت می‌توانند همچنین یک پرچم is_premium برگردانند. اگر برنامه شما نیاز به دانستن هزینه فعلی در سطح حساب دارد، قبل از ارسال درخواست پولی از نقطه دسترسی قیمت استفاده کنید.

دسترسی رایگان API سطح قیمت‌گذاری شما را تغییر نمی‌دهد. حساب‌های بازار از قیمت‌گذاری حساب بازار استفاده می‌کنند؛ حساب‌های فروشنده مجدد نیز از قیمت‌گذاری اختصاص‌یافته به سطح فروشنده مجدد فعلی خود استفاده می‌کنند.

دریافت قیمت دامنه مشاهده قیمت دامنه‌ها مقایسه طرح‌های فروشندگان مجدد

عملیات دامنه و DNS

تفاوت بین Nameservers، رکوردهای DNS و Child Nameservers را بدانید

عملیات	زمان استفاده	قابلیت مستندشده
به‌روزرسانی سرورهای نام	می‌خواهید یک دامنه را به Nameservers معتبر متفاوت واگذار کنید.	Endpoint نام‌سرور دامنه از یک Nameserver اصلی، ثانویه و اضافی پشتیبانی می‌کند و صفحه فعلی حداکثر شش مورد را مستند کرده است.
رکوردهای DNS	شما از میزبانی DNS NiceNIC استفاده می‌کنید و نیاز به مدیریت رکوردهای منطقه دارید.	APIهای جداگانه برای فهرست‌کردن، ایجاد، به‌روزرسانی و حذف رکوردهای DNS مستند شده‌اند.
نامسرورهای فرزند	به رکوردهای host / glue مانند `ns1.example.com` نیاز دارید.	ایجاد، فهرست‌کردن، به‌روزرسانی و حذف Child Nameservers. Endpoint ایجاد نیاز دارد که نام میزبان Nameserver با دامنه مطابقت داشته باشد و یک آدرس IP را می‌پذیرد.

پرتفوی و انطباق

اتوماسیون نظارت بر پورتفولیو، نه فقط سفارش‌های دامنه

دامنه API نسخه ۲ همچنین شامل عملیات خواندنی است که پس از ثبت‌نام مفید هستند. نقطه پایانی List Domains از صفحه‌بندی، مرتب‌سازی، فیلتر بر اساس وضعیت و فیلتر بر اساس نگهداری پشتیبانی می‌کند، در حالی که Get Domain Details اطلاعات تاریخ ثبت، تاریخ انقضا، سرورهای نام‌گذاری و اطلاعات تماس ثبت‌کننده را بازمی‌گرداند.

پایش سوءاستفاده و انطباق

API سوءاستفاده و انطباق NiceNIC می‌تواند دامنه‌های دارای گزارش سوءاستفاده را فهرست کند و خلاصه‌ای دقیق و قابل خواندن توسط ماشین برای یک دامنه خاص بازگرداند. نقطه پایانی گزارش دقیق سوءاستفاده، شش عبارت وضعیت در سطح دامنه را مستند می‌کند: Normal، Under Review، Pending ClientHold، ClientHold، Closed و ServerHold.

پاسخ می‌تواند شامل تأثیر فعلی، اقدام پیشنهادی بعدی، وضعیت و زمان‌بندی تعلیق، تعداد شکایات، تاریخ شکایات، دسته‌بندی‌ها، طبقه‌بندی سوءاستفاده DNS، وضعیت شواهد و URLهای گزارش‌شده در صورت وجود باشد. این امکان به پلتفرم‌ها و فروشندگان اینترنتی می‌دهد که وضعیت انطباق را در سیستم‌های عملیاتی خود نمایش دهند و تنها به بررسی دستی وابسته نباشند.

فهرست دامنه‌ها فهرست گزارش‌های سوءاستفاده دریافت گزارش سوءاستفاده

API مستقیم یا WHMCS

مدل یکپارچه‌سازی متناسب با سیستم خود را انتخاب کنید

گزینه	بهترین گزینه برای	آنچه مستندات فعلی ارائه می‌دهد
Domain API نسخه ۲	وب‌سایت‌های سفارشی، پلتفرم‌های SaaS، سیستم‌های داخلی، گردش‌های کاری صورتحساب یا تأمین سفارشی.	یکپارچه‌سازی مستقیم HTTPS + JSON در عملیات دامنه، DNS، نام‌سرور فرزند، حساب و انطباق.
ماژول WHMCS	شرکت‌های میزبانی و فروشندگان مجدد که قبلاً از WHMCS استفاده می‌کنند.	بررسی موجودیت، ثبت، تمدید، انتقال، جزئیات دامنه، نام‌سرورها، مخاطبین، قفل/باز کردن قفل، دریافت EPP، ثبت خطا و حالت آزمایشی اختیاری.

مستندات فعلی WHMCS، WHMCS نسخه ۷.۰ یا بالاتر، PHP نسخه ۷.۰ یا بالاتر با cURL، اعتبارنامه‌های معتبر NiceNIC API و پشتیبانی از SSL/TLS را به عنوان پیش‌نیاز فهرست می‌کند.

مشاهده WHMCS API

عیبیابی

زمانی که یک درخواست API ناموفق است

با پاسخ بازگشتی و وضعیت پیکربندی شروع کنید، به‌جای تکرار مکرر همان اقدام پرداختی.

خطای احراز هویت یا دسترسی

نام کاربری NiceNIC و API Secret را تأیید کنید.
مطمئن شوید که هدر Authorization وجود دارد و به درستی قالب‌بندی شده است.
مطمئن شوید که API Secret بازنشانی یا چرخانده نشده است.
اگر محدودیت‌های IP فعال هستند، مطمئن شوید که درخواست از IP سرور خروجی مجاز ارسال می‌شود.

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

درخواست را با پارامترهای مستند شده برای endpoint خاص مقایسه کنید.
مقادیر، قالب‌ها و نام اقدامات مورد نیاز را تأیید کنید.
در صورت وجود، دوره‌های ثبت‌نام یا الزامات تماس مربوط به TLD را بررسی کنید.

عملیات پرداختی بلافاصله تکمیل نمی‌شود

کد code و پیام msg بازگردانده‌شده را بخوانید.
پاسخ معلق 201 را به‌عنوان تکمیل نهایی در نظر نگیرید.
قبل از تلاش مجدد برای یک اقدام پرداختی، موجودی حساب و قیمت‌گذاری فعلی را تأیید کنید.

نیاز به پشتیبانی NiceNIC دارید؟

زمان درخواست و عملیات API را ثبت کنید.
در صورت امکان، نام دامنه یا شیء مربوطه را ذکر کنید.
کد و پیام بازگشتی را درج کنید.
فقط پارامترهای غیرحساس را به اشتراک بگذارید؛ هرگز کل API Secret را در تیکت وارد نکنید.

ارسال تیکت

مرحله بعد

با یک درخواست آزمایشی امن شروع کنید

دسترسی API را فعال کنید، احراز هویت را تأیید کنید، یک درخواست بررسی موجودی یا قیمت اجرا کنید، و مدیریت پاسخ خود را قبل از فعال‌سازی عملیات پولی رو‌به‌روی مشتری بررسی کنید.

فعال‌سازی دسترسی API بررسی موجودی دامنه دریافت قیمت دامنه

آخرین بررسی: ۲۶ اوت ۲۰۲۶