เอกสาร NiceNIC Domain API v2 และเริ่มต้นใช้งานด่วน
NiceNIC Domain API v2 ใช้งานได้กับทั้งบัญชีตลาดและบัญชีรีเซลเลอร์ ใช้ภาพรวมนี้เพื่อกำหนดค่าการเข้าถึง ยืนยันคำขอแรกของคุณ ทำความเข้าใจโมเดลการตอบสนองของ API และไปยังส่วนที่ถูกต้องในเมนูนำทางด้านซ้ายโดยตรง
บัญชี Market: การเข้าถึง API พร้อมราคาบัญชี Market
บัญชีผู้ค้าปลีก: การเข้าถึง API พร้อมราคาที่กำหนดตามระดับผู้ค้าปลีกปัจจุบัน
เปรียบเทียบระดับและราคาผู้ค้าปลีก →
ทดสอบการเชื่อมต่อของคุณก่อนเปิดใช้งานจริง
ใช้ NiceNIC API Sandbox เพื่อทดสอบการเชื่อมต่อ Domain API ของคุณก่อนย้ายไปยังระบบผลิตจริง ตรวจสอบการยืนยันตัวตน คำขอ API การจัดการการตอบสนอง และขั้นตอนการทำงานของแอปพลิเคชันของคุณในสภาพแวดล้อมการทดสอบโดยเฉพาะ
เหมาะสำหรับผู้รับจดทะเบียน ผู้ให้บริการโฮสติ้ง นักพัฒนา และแพลตฟอร์มที่เตรียมการเชื่อมต่อ API
สร้างคำขอ API ครั้งแรกของคุณใน 4 ขั้นตอน
เริ่มต้นด้วยคำขอแบบอ่านอย่างเดียวก่อนเปิดใช้งานการจดทะเบียน การต่ออายุ หรือการโอนย้ายแบบจริง ซึ่งช่วยให้คุณตรวจสอบการยืนยันตัวตน รูปแบบคำขอ และการจัดการการตอบสนองได้โดยไม่ต้องวางคำสั่งซื้อที่ต้องชำระเงิน
เปิดใช้งานการเข้าถึง API
เปิดการตั้งค่า API สร้างหรือดึงข้อมูล API Secret ของคุณ และกำหนดค่า IP ของเซิร์ฟเวอร์ที่ได้รับอนุญาตตามความเหมาะสม
ยืนยันการตรวจสอบสิทธิ์
ใช้ HTTPS พร้อมส่วนหัว Authorization ในรูปแบบ username:api_secret
ทดสอบอย่างปลอดภัย
เริ่มต้นด้วยการตรวจสอบความพร้อมของโดเมน ราคา ยอดคงเหลือในบัญชี หรือรายการโดเมน
จัดการการตอบกลับ
อ่านและจัดเก็บ code และ msg ที่ส่งคืนก่อนเปิดใช้งานการดำเนินการผลิตแบบชำระเงิน
คำขอแรกที่แนะนำ: การตรวจสอบความพร้อมใช้งานของโดเมน
เอนด์พอยต์การตรวจสอบความพร้อมใช้งานรองรับการตรวจสอบหลายโดเมนในคำขอเดียวโดยคั่นชื่อโดเมนด้วยเครื่องหมายจุลภาค
เลือกขั้นตอนการทำงานที่คุณต้องการ
ภาพรวมด้านล่างสอดคล้องกับเมนูนำทางด้านซ้าย ใช้เพื่อระบุขั้นตอนการทำงานที่ถูกต้อง จากนั้นเปิดหน้ารายละเอียดเอนด์พอยต์เพื่อดูพารามิเตอร์ ตัวอย่างคำขอ และตัวอย่างการตอบสนอง
| หมวดหมู่ | ใช้สำหรับ | ฟังก์ชันที่มีเอกสาร |
|---|---|---|
| เริ่มต้นใช้งาน | เชื่อมต่ออย่างปลอดภัยและทำความเข้าใจการจัดการการตอบสนอง | ภาพรวม API, Sandbox ของ API, การยืนยันตัวตน, รหัสการตอบสนอง |
| การจัดการโดเมน | ทำให้วงจรชีวิตโดเมนหลักเป็นอัตโนมัติ | ความพร้อมใช้งาน, รายการโดเมน, รายละเอียดโดเมน, การลงทะเบียน, การต่ออายุ, การโอนย้ายเข้า, เนมเซิร์ฟเวอร์, ผู้ติดต่อ, ราคา |
| การละเมิดและการปฏิบัติตามข้อกำหนด | ตรวจสอบโดเมนที่ต้องให้ความสนใจด้านการปฏิบัติตามข้อกำหนด | แสดงรายการโดเมนที่มีรายงานการละเมิด และดึงข้อมูลสถานะการละเมิดที่เครื่องอ่านได้, วงจรชีวิตการระงับ, ข้อมูลการร้องเรียน และการดำเนินการที่แนะนำ |
| ระเบียน DNS | จัดการระเบียน DNS ที่โฮสต์ไว้โดยใช้โปรแกรม | แสดงรายการ, สร้าง, อัปเดต และลบระเบียน DNS |
| เนมเซิร์ฟเวอร์รอง | จัดการระเบียนโฮสต์ / glue สำหรับเนมเซิร์ฟเวอร์ภายใต้โดเมนของคุณเอง | สร้าง, แสดงรายการ, อัปเดต และลบเนมเซิร์ฟเวอร์ย่อย |
| บัญชีและการเรียกเก็บเงิน | เชื่อมต่อระบบอัตโนมัติเข้ากับการตรวจสอบในระดับบัญชี | ยอดเงินในบัญชีและข้อมูลบัญชีที่เกี่ยวข้องกับธุรกรรม |
| WHMCS API | ผสานรวม NiceNIC เข้ากับขั้นตอนการทำงานการเรียกเก็บเงิน WHMCS ที่มีอยู่ | ความพร้อมใช้งาน, การลงทะเบียน, การต่ออายุ, การโอนย้าย, รายละเอียดโดเมน, เนมเซิร์ฟเวอร์, ผู้ติดต่อ และฟังก์ชันโมดูลผู้รับจดทะเบียนเพิ่มเติม |
| คำถามที่พบบ่อยเกี่ยวกับ API | แก้ไขคำถามทั่วไปเกี่ยวกับการเข้าถึง ความปลอดภัย การทดสอบ และขั้นตอนการทำงาน | คุณสมบัติ ข้อมูลรับรอง การจัดการคำขอ การดำเนินการที่รองรับ และคำแนะนำในการเชื่อมต่อ |
ลำดับการเชื่อมต่อครั้งแรกที่แนะนำ
การเชื่อมต่อในระบบผลิตจริงที่เชื่อถือได้ควรตรวจสอบเงื่อนไขการเข้าถึงและการซื้อก่อนที่จะเริ่มส่งคำสั่งซื้อจากลูกค้าจริง
API Secret + IP ที่ได้รับอนุญาต
การทดสอบการเชื่อมต่อแบบอ่านอย่างเดียว
สอบถามต้นทุนระดับบัญชีปัจจุบัน
ยืนยันเงินทุนสำหรับการดำเนินการที่ต้องชำระเงิน
ประมวลผล code + msg
จดทะเบียน / ต่ออายุ / โอนย้าย
ทำความเข้าใจการตอบสนองแบบสำเร็จ แบบรอดำเนินการ และแบบข้อผิดพลาด
code: 0 — การตอบสนองแบบสำเร็จ ตัวอย่างของเอนด์พอยต์ปัจจุบันใช้รหัส 0 สำหรับการตอบสนองที่เสร็จสมบูรณ์แล้ว
code: 201 — คำสั่งซื้อที่รอดำเนินการ เอกสารการจดทะเบียนและการโอนสามารถส่งคืนรหัส 201 เมื่อมีการส่งคำสั่งซื้อแล้ว แต่การประมวลผลขั้นสุดท้ายยังคงรอดำเนินการอยู่
code: 400 — ข้อผิดพลาดของคำขอ ตัวอย่างของเอนด์พอยต์ใช้รหัส 400 สำหรับข้อผิดพลาดของพารามิเตอร์คำขอ
พฤติกรรมเมื่อการจดทะเบียนยังรอดำเนินการ
สำหรับการจดทะเบียนโดเมน เอกสารปัจจุบันระบุว่าการตอบสนองด้วยรหัส 201 หมายความว่าคำสั่งซื้อถูกส่งสำเร็จและหักค่าธรรมเนียมแล้ว แต่การเปิดใช้งานขั้นสุดท้ายยังคงขึ้นอยู่กับการยืนยันจากทะเบียน หากไม่สามารถเปิดใช้งานโดเมนได้ ค่าธรรมเนียมการจดทะเบียนจะถูกคืนเข้าสู่ยอดเงินในบัญชี NiceNIC ภายใน 24 ชั่วโมง
พฤติกรรมเมื่อการโอนยังรอดำเนินการ
เอนด์พอยต์สำหรับการโอนยังระบุรหัส 201 เป็นคำสั่งซื้อที่รอดำเนินการด้วย ดังนั้นแอปพลิเคชันของคุณควรถือว่าการโอนที่รอดำเนินการเป็นการยอมรับให้ดำเนินการ ไม่ใช่หลักฐานว่าการโอนเสร็จสมบูรณ์แล้ว
สอบถามราคาก่อนดำเนินการที่มีค่าใช้จ่าย
Endpoint ราคาของ NiceNIC สามารถดึงราคาการจดทะเบียน การต่ออายุ และการโอนย้ายโดเมนได้ ค่า type ที่ระบุในเอกสารประกอบด้วย register, renew, transfer และ all ระยะเวลาที่ระบุในเอกสารคือ 1 ถึง 10 ปี โดยอาจมีข้อยกเว้นเฉพาะ TLD
การตอบกลับด้านราคาการจดทะเบียนสามารถส่งคืนแฟล็ก is_premium ได้ด้วย ใช้ endpoint ราคาก่อนส่งคำขอที่ต้องชำระเงินเมื่อแอปพลิเคชันของคุณจำเป็นต้องทราบค่าใช้จ่ายระดับบัญชีปัจจุบัน
ทำความเข้าใจความแตกต่างระหว่างเนมเซิร์ฟเวอร์ ระเบียน DNS และเนมเซิร์ฟเวอร์ย่อย
| การทำงาน | ควรใช้เมื่อใด | ความสามารถที่ระบุไว้ในเอกสาร |
|---|---|---|
| อัปเดตเนมเซิร์ฟเวอร์ | คุณต้องการมอบหมายโดเมนให้กับเนมเซิร์ฟเวอร์ผู้มีอำนาจที่แตกต่างกัน | เอนด์พอยต์ของเนมเซิร์ฟเวอร์โดเมนรองรับเนมเซิร์ฟเวอร์หลัก รอง และเพิ่มเติม โดยหน้าปัจจุบันระบุขีดจำกัดสูงสุด 6 เครื่อง |
| ระเบียน DNS | คุณใช้บริการ DNS โฮสติ้งของ NiceNIC และต้องการจัดการระเบียนโซน | มีเอกสาร API แยกต่างหากสำหรับการแสดงรายการ การสร้าง การอัปเดต และการลบระเบียน DNS |
| เนมเซิร์ฟเวอร์รอง | คุณจำเป็นต้องมีระเบียนโฮสต์ / กลู เช่น ns1.example.com |
สร้าง แสดงรายการ อัปเดต และลบเนมเซิร์ฟเวอร์ย่อย ปลายทางสำหรับการสร้างต้องการให้ชื่อโฮสต์ของเนมเซิร์ฟเวอร์ตรงกับโดเมน และยอมรับที่อยู่ IP |
ทำให้การตรวจสอบพอร์ตโฟลิโอเป็นอัตโนมัติ ไม่ใช่แค่คำสั่งซื้อโดเมน
Domain API v2 ยังรวมถึงการดำเนินการแบบอ่านที่มีประโยชน์หลังการลงทะเบียน ปลายทาง List Domains รองรับการแบ่งหน้า การจัดเรียง การกรองสถานะ และการกรองการระงับ ในขณะที่ Get Domain Details ส่งคืนวันที่ลงทะเบียน วันที่หมดอายุ เนมเซิร์ฟเวอร์ และข้อมูลติดต่อของผู้จดทะเบียน
การตรวจสอบการละเมิดและการปฏิบัติตามข้อกำหนด
API ด้านการละเมิดและการปฏิบัติตามข้อกำหนดของ NiceNIC สามารถแสดงรายการโดเมนที่มีรายงานการละเมิด และส่งคืนสรุปโดยละเอียดที่เครื่องอ่านได้สำหรับโดเมนเฉพาะ ปลายทางสำหรับการละเมิดโดยละเอียดระบุวลีสถานะระดับโดเมนหกสถานะ: ปกติ อยู่ระหว่างการตรวจสอบ รอ ClientHold, ClientHold, ปิด และ ServerHold
การตอบกลับสามารถรวมถึงผลกระทบปัจจุบัน การดำเนินการถัดไปที่แนะนำ สถานะการระงับและไทม์ไลน์ จำนวนข้อร้องเรียน วันที่ร้องเรียน หมวดหมู่ การจำแนกประเภทการละเมิด DNS สถานะหลักฐาน และ URL ที่ถูกรายงานตามความเหมาะสม ซึ่งช่วยให้แพลตฟอร์มและผู้ค้าปลีกแสดงสถานะการปฏิบัติตามข้อกำหนดภายในระบบปฏิบัติการของตนเอง แทนที่จะพึ่งพาการตรวจสอบด้วยตนเองเท่านั้น
เลือกโมเดลการเชื่อมต่อที่เหมาะกับระบบของคุณ
| ตัวเลือก | เหมาะสำหรับ | เอกสารปัจจุบันให้อะไรบ้าง |
|---|---|---|
| Domain API v2 | เว็บไซต์ที่ออกแบบเอง แพลตฟอร์ม SaaS ระบบภายใน ระบบการเรียกเก็บเงินหรือขั้นตอนการจัดเตรียมบริการแบบกำหนดเอง | การเชื่อมต่อ HTTPS + JSON โดยตรงครอบคลุมโดเมน DNS เนมเซิร์ฟเวอร์ย่อย บัญชี และการดำเนินการด้านการปฏิบัติตามข้อกำหนด |
| โมดูล WHMCS | บริษัทโฮสติ้งและผู้ให้บริการตัวแทนจำหน่ายที่ใช้ WHMCS อยู่แล้ว | การตรวจสอบความพร้อมใช้งาน การจดทะเบียน การต่ออายุ การโอนย้าย รายละเอียดโดเมน เนมเซิร์ฟเวอร์ ผู้ติดต่อ ล็อก/ปลดล็อก การดึงข้อมูล EPP การบันทึกข้อผิดพลาด และโหมดทดสอบเสริม |
เอกสาร WHMCS ปัจจุบันระบุข้อกำหนดว่า WHMCS 7.0 ขึ้นไป, PHP 7.0 ขึ้นไปพร้อม cURL, ข้อมูลรับรอง API ของ NiceNIC ที่ถูกต้อง และการรองรับ SSL/TLS
เมื่อคำขอ API ล้มเหลว
เริ่มต้นจากผลตอบกลับที่ได้รับและสถานะการกำหนดค่าก่อน แทนที่จะลองดำเนินการที่ต้องชำระเงินซ้ำ ๆ หลายครั้ง
ข้อผิดพลาดการตรวจสอบสิทธิ์หรือการเข้าถึง
- ยืนยันชื่อผู้ใช้ NiceNIC และ API Secret
- ยืนยันว่าส่วนหัว Authorization มีอยู่และมีรูปแบบถูกต้อง
- ยืนยันว่า API Secret ยังไม่ถูกรีเซ็ตหรือหมุนเวียน
- หากเปิดใช้การจำกัด IP ให้ยืนยันว่าคำขอมานจาก IP ของเซิร์ฟเวอร์ขาออกที่ได้รับอนุญาต
ข้อผิดพลาดพารามิเตอร์คำขอ
- เปรียบเทียบคำขอกับพารามิเตอร์ที่ระบุไว้ในเอกสารของเอนด์พอยต์นั้น ๆ
- ยืนยันค่าที่จำเป็น รูปแบบ และชื่อการดำเนินการ
- ตรวจสอบระยะเวลาจดทะเบียนหรือข้อกำหนดด้านผู้ติดต่อเฉพาะ TLD ตามที่เกี่ยวข้อง
การดำเนินการแบบชำระเงินไม่เสร็จสมบูรณ์ทันที
- อ่าน
codeและmsgที่ส่งกลับมา - อย่าถือว่าการตอบสนองแบบรอดำเนินการ
201เป็นการเสร็จสมบูรณ์ขั้นสุดท้าย - ยืนยันยอดเงินในบัญชีและราคาปัจจุบันก่อนลองดำเนินการแบบชำระเงินอีกครั้ง
ต้องการความช่วยเหลือจาก NiceNIC
- บันทึกเวลาประทับของคำขอและการดำเนินการ API
- ระบุชื่อโดเมนหรือออบเจกต์ที่เกี่ยวข้อง หากมี
- ระบุรหัสและข้อความที่ส่งกลับมาด้วย
- แชร์เฉพาะพารามิเตอร์ที่ไม่เป็นความลับเท่านั้น ห้ามโพสต์ค่า API Secret ทั้งหมดในใบขอรับบริการ
เริ่มต้นด้วยคำขอทดสอบที่ปลอดภัย
เปิดใช้งานการเข้าถึง API ตรวจสอบการยืนยันตัวตน ส่งคำขอตรวจสอบความพร้อมใช้งานหรือราคา และตรวจสอบการจัดการผลตอบกลับของคุณก่อนเปิดใช้งานการดำเนินการแบบชำระเงินสำหรับลูกค้า






