نظرة عامة على API

توثيق API لنطاقات NiceNIC الإصدار 2 والبدء السريع

تتوفر NiceNIC Domain API v2 لكل من حسابات السوق وحسابات إعادة البيع. استخدم هذه النظرة العامة لتكوين الوصول، وتأكيد طلبك الأول، وفهم نموذج استجابة API، والانتقال مباشرة إلى القسم الصحيح في التنقل الأيسر.

الوصول إلى API وأسعار إعادة البيع منفصلان.
حساب السوق: الوصول إلى API مع أسعار حساب السوق.
حساب الموزع: الوصول إلى API مع الأسعار المخصصة للمستوى الحالي للموزع.
قارن مستويات وأسعار الموزعين ←

تفعيل الوصول إلى 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

اختبر تكاملك قبل الانتقال إلى بيئة الإنتاج

استخدم بيئة الاختبار API Sandbox من NiceNIC لاختبار تكاملك مع Domain API قبل الانتقال إلى بيئة الإنتاج. تحقق من المصادقة وطلبات API ومعالجة الاستجابات وسير عمل تطبيقك في بيئة اختبار مخصصة.

مثالي للموزعين ومزودي الاستضافة والمطورين والمنصات التي تجهّز تكاملًا مع API.

استكشف API Sandbox ←

بدء سريع

قم بإجراء أول استدعاء API في 4 خطوات

ابدأ بطلب للقراءة فقط قبل تفعيل عمليات التسجيل أو التجديد أو النقل المباشرة. يتيح لك ذلك التحقق من المصادقة وتنسيق الطلب ومعالجة الاستجابة دون تقديم طلب مدفوع.

1

تفعيل الوصول إلى API

افتح إعدادات API، وأنشئ أو استرجع Secret الخاص بـ 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.
خوادم الأسماء الفرعية	إدارة سجلات المضيف / glue لخوادم الأسماء ضمن نطاقك الخاص.	إنشاء، قائمة، تحديث وحذف خوادم الأسماء الفرعية.
الحساب والفواتير	ربط الأتمتة بفحوصات مستوى الحساب.	رصيد الحساب ومعلومات الحساب المتعلقة بالمعاملات.
WHMCS API	دمج NiceNIC في سير عمل فوترة WHMCS الحالي.	التوفر، التسجيل، التجديد، النقل، تفاصيل النطاق، خوادم الأسماء، جهات الاتصال ووظائف وحدة السجل الإضافية.
الأسئلة الشائعة حول API	حل الأسئلة الشائعة حول الوصول والأمان والاختبار وسير العمل.	الأهلية، بيانات الاعتماد، معالجة الطلبات، العمليات المدعومة وإرشادات التكامل.

سير العمل الموصى به

تسلسل التكامل الأول الموصى به

يجب أن يتحقق التكامل الإنتاجي الموثوق من شروط الوصول والشراء قبل بدء إرسال طلبات العملاء المباشرة.

1. المصادقة
سر API + عنوان IP مصرح به

→

2. التوفر
اختبار الاتصال للقراءة فقط

→

3. التسعير
الاستعلام عن التكلفة الحالية على مستوى الحساب

→

4. الرصيد
تأكيد الأموال للإجراءات المدفوعة

→

5. معالجة الاستجابة
معالجة الرمز + الرسالة

→

6. العمليات المباشرة
تسجيل / تجديد / نقل

لا تفترض أن طلب API مكتمل لمجرد أنه تم قبوله. قد تُرجع بعض العمليات حالة معلقة وتظل بحاجة إلى معالجة السجل قبل تأكيد الحالة النهائية للنطاق.

سلوك الإنتاج

فهم استجابات النجاح والقيد الانتظار والخطأ

code: 0 — استجابة ناجحة تستخدم الأمثلة الحالية لنقطة النهاية الكود 0 للاستجابات المكتملة بنجاح.

code: 201 — طلب قيد الانتظار يمكن لوثائق التسجيل والنقل إرجاع الكود 201 عندما يتم تقديم طلب ولكن لا تزال المعالجة النهائية قيد الانتظار.

code: 400 — خطأ في الطلب تستخدم أمثلة نقطة النهاية الكود 400 لأخطاء معلمات الطلب.

سلوك التسجيل المعلق

بالنسبة لتسجيل النطاق، تنص الوثائق الحالية على أن استجابة 201 تعني أن الطلب تم إرساله بنجاح وتم خصم الرسوم، لكن التفعيل النهائي لا يزال خاضعًا لتأكيد السجل. إذا تعذر تفعيل النطاق، فسيتم إرجاع رسوم التسجيل إلى رصيد حساب NiceNIC خلال 24 ساعة.

سلوك النقل المعلق

توثق نقطة نهاية النقل أيضًا 201 كطلب معلق. لذلك يجب أن يعالج تطبيقك النقل المعلق كطلب مقبول للمعالجة، وليس كدليل على اكتمال النقل بالفعل.

وثائق تسجيل النطاق وثائق نقل النطاق

التسعير

الاستعلام عن الأسعار قبل العمليات المدفوعة

يمكن لنقطة نهاية الأسعار في NiceNIC استرداد أسعار تسجيل النطاق وتجديده ونقله. قيم type الموثقة هي register وrenew وtransfer وall. الفترة الموثقة هي من 1 إلى 10 سنوات، مع إمكانية وجود استثناءات خاصة بنطاقات TLD.

يمكن أن تعيد استجابات أسعار التسجيل أيضًا علامة is_premium. استخدم نقطة نهاية الأسعار قبل إرسال طلب مدفوع عندما يحتاج تطبيقك إلى معرفة التكلفة الحالية على مستوى الحساب.

الوصول المجاني إلى API لا يغير مستوى الأسعار الخاص بك. تستخدم حسابات السوق تسعير حساب السوق؛ وتستخدم حسابات الموزعين التسعير المخصص لمستوى الموزع الحالي الخاص بهم.

الحصول على أسعار النطاقات عرض أسعار النطاقات مقارنة خطط الموزعين

عمليات النطاق وDNS

تعرف على الفرق بين خوادم الأسماء وسجلات DNS وخوادم الأسماء الفرعية

العملية	استخدمها عندما	القدرة الموثقة
تحديث خوادم الأسماء	ترغب في تفويض نطاق إلى خوادم أسماء موثوقة مختلفة.	تدعم نقطة نهاية خادم أسماء النطاق خوادم أسماء أساسية وثانوية وإضافية، وتوثّق الصفحة الحالية حدًا أقصى يصل إلى ستة.
سجلات DNS	أنت تستخدم استضافة DNS الخاصة بـ NiceNIC وتحتاج إلى إدارة سجلات المنطقة.	تتوفر وثائق لواجهات API منفصلة لعرض سجلات DNS وإنشائها وتحديثها وحذفها.
خوادم الأسماء الفرعية	تحتاج إلى سجلات مضيف / لاصقة مثل `ns1.example.com`.	إنشاء خوادم الأسماء الفرعية وإدراجها وتحديثها وحذفها. تتطلب نقطة نهاية الإنشاء أن يتطابق اسم مضيف خادم الأسماء مع النطاق وتقبل عنوان IP.

المحفظة والامتثال

أتمتة مراقبة المحفظة، وليس طلبات النطاقات فقط

يشمل Domain API v2 أيضًا عمليات القراءة المفيدة بعد التسجيل. تدعم نقطة نهاية List Domains الترقيم والفرز وتصفية الحالة وتصفية التعليق، بينما تُرجع Get Domain Details تواريخ التسجيل وتواريخ الانتهاء وخوادم الأسماء ومعلومات جهة الاتصال للمسجِّل.

مراقبة الانتهاكات والامتثال

يمكن لـ NiceNIC's Abuse & Compliance API سرد النطاقات التي تحتوي على تقارير انتهاكات وإرجاع ملخص تفصيلي قابل للقراءة آليًا لنطاق محدد. توثّق نقطة نهاية الانتهاكات التفصيلية ست عبارات حالة على مستوى النطاق: عادي، قيد المراجعة، تعليق العميل معلق، تعليق العميل، مغلق، وتعليق الخادم.

يمكن أن يتضمن الرد التأثير الحالي، والإجراء التالي الموصى به، وحالة التعليق والجدول الزمني، وعدد الشكاوى، وتواريخ الشكاوى، والفئات، وتصنيف انتهاكات DNS، وحالة الأدلة، وعناوين URL المبلغ عنها عند الاقتضاء. وهذا يسمح للمنصات والموزعين بعرض حالة الامتثال داخل أنظمتهم التشغيلية الخاصة بدلاً من الاعتماد فقط على المراجعة اليدوية.

قائمة النطاقات قائمة تقارير الانتهاكات الحصول على تقرير الانتهاكات

API مباشر أو WHMCS

اختر نموذج التكامل الذي يناسب نظامك

الخيار	الأفضل لـ	ما توفره الوثائق الحالية
Domain API v2	المواقع المخصصة، منصات SaaS، الأنظمة الداخلية، سير عمل الفوترة أو التزويد المخصص.	تكامل مباشر عبر HTTPS + JSON عبر عمليات النطاق وDNS وخوادم الأسماء الفرعية والحساب والامتثال.
وحدة WHMCS	شركات الاستضافة والموزعون الذين يستخدمون WHMCS بالفعل.	التحقق من التوفر، التسجيل، التجديد، النقل، تفاصيل النطاق، خوادم الأسماء، جهات الاتصال، القفل/فتح القفل، استرجاع EPP، تسجيل الأخطاء ووضع الاختبار الاختياري.