โหลดรายการตัวเลือกสำหรับการลงทะเบียนส่งข้อความ

โหลดตัวเลือกก่อนสร้างแบบฟอร์มลงทะเบียน

ใช้รายการตัวเลือกการลงทะเบียนส่งข้อความฉบับปัจจุบันเพื่อเติมตัวเลือก แทนการกำหนดค่าของหน่วยงานทะเบียนตายตัวไว้ในโค้ด สำหรับแบบฟอร์มแบรนด์ พอร์ทัลจะโหลดรายการประเภทธุรกิจ อุตสาหกรรม ประเภทตัวระบุธุรกิจทางเลือก ความสัมพันธ์กับแบรนด์ ประเทศ รัฐของสหรัฐอเมริกา และตลาดหลักทรัพย์ สำหรับแบบฟอร์มแคมเปญ พอร์ทัลจะโหลดกรณีการใช้งาน กรณีการใช้งานย่อยที่ใช้ได้ และพันธมิตรการเชื่อมต่อ เก็บค่าที่เครื่องใช้แต่ละค่าที่ส่งกลับไว้คู่กับป้ายกำกับที่แสดง เมื่อสร้างคำขอในภายหลัง ให้ใช้ค่านั้น ไม่ใช่ป้ายกำกับที่แปลแล้ว

เลือกรายการตัวเลือก

จัดการการตอบกลับจาก TCR โดยตรง

เนื้อหาการตอบกลับมาจาก API ของ TCR โดยตรง ต่างจากจุดปลายทางรุ่นเก่าหลายแห่งใน /v3 โดยไม่มีการเพิ่มส่วนห่อหุ้ม status/response ตรวจสอบสถานะ HTTP ก่อนตีความเนื้อหา รายการตัวเลือกอาจมีป้ายกำกับแบบสตริงหรือคำจำกัดความแบบมีโครงสร้าง จึงไม่ควรสันนิษฐานว่าทุกค่ามีฟิลด์เหมือนกัน หากคำขอ HTTP สำเร็จ แต่เนื้อหาไม่ใช่ JSON ที่ถูกต้องตามโครงสร้างที่คาดไว้ ให้รายงานว่าการค้นหาล้มเหลว แทนที่จะแทนเนื้อหาด้วยรายการว่างโดยไม่แจ้งให้ทราบ

แยกตัวเลือกในรายการออกจากการตรวจสอบคุณสมบัติและการกำหนดราคา

รายการกรณีการใช้งานทั่วไปไม่ได้บอกว่าแบรนด์ใดแบรนด์หนึ่งมีคุณสมบัติเหมาะสมกับกรณีการใช้งานใดบ้าง พอร์ทัลปัจจุบันจะค้นหาคุณสมบัติเฉพาะของแบรนด์ก่อนสร้างแคมเปญ และตรวจสอบข้อกำหนดของผู้ให้บริการเครือข่ายที่เลือก เช่นเดียวกัน ข้อมูลเมตาค่าธรรมเนียมของผู้จัดหาไม่ใช่ราคาขายปลีกสุดท้ายของบัญชี ให้ตรวจสอบราคาที่ใช้กับบัญชีและข้อกำหนดการลงทะเบียนแยกต่างหาก การโหลดรายการตัวเลือกไม่ได้เป็นการอนุมัติแบรนด์ แคมเปญ หรือหมายเลขสำหรับส่งข้อความ

จัดการเมื่อรายการตัวเลือกไม่พร้อมใช้งาน

เก็บข้อมูลที่ลูกค้ากรอกในแบบฟอร์มไว้หากการค้นหาล้มเหลว แสดงข้อผิดพลาด ปฏิบัติตาม Retry-After เมื่อมีการส่งกลับมา และเพิ่มช่วงเวลารอก่อนลองใหม่ อย่าโหลดรายการตัวเลือกทั้งหมดซ้ำอย่างต่อเนื่อง หรือถือว่าข้อผิดพลาดจากการจำกัดอัตราคำขอหรือการรับส่งข้อมูลเป็นรายการว่างที่ถูกต้อง คำขอ GET นี้ไม่ต้องใช้คีย์ป้องกันการประมวลผลซ้ำ และไม่มีการนำผลจากแหล่งเก็บข้อมูลป้องกันการประมวลผลซ้ำสำหรับคำขอเปลี่ยนแปลงข้อมูลมาตอบกลับซ้ำ

คำขอ

ใช้บัญชี API ที่เปิดใช้งานแล้วผ่าน HTTPS จากที่อยู่ IP ต้นทางที่ได้รับอนุญาต เส้นทางปัจจุบันรองรับนโยบายการยืนยันตัวตนของบัญชี รวมถึงการยืนยันตัวตนแบบ Basic และบัญชี API แบบโทเค็นผู้ถือที่เปิดใช้งานแล้ว อย่าใช้ข้อมูลรับรองของผู้ให้บริการ

ส่งคำขอ GET โดยระบุชื่อรายการตัวเลือกที่รองรับไว้ในเส้นทาง ส่งตัวกรองรายการที่เกี่ยวข้องในสตริงคำค้น ไม่จำเป็นต้องมีเนื้อหาคำขอ

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"

การตอบกลับ

เส้นทาง TCR นี้ส่งเนื้อหาจากหน่วยงานทะเบียนกลับโดยตรงพร้อมสถานะ HTTP ที่เกี่ยวข้อง โดยไม่ใช้ส่วนห่อหุ้ม status.code/status.msg/response แบบเก่าของ v3 โครงสร้างของรายการตัวเลือกแตกต่างกัน บางรายการจับคู่ค่ากับออบเจ็กต์คำอธิบาย ส่วนรายการอื่นจับคู่ค่ากับสตริง ให้คงคีย์ที่เครื่องอ่านได้ไว้เมื่อส่งแบบฟอร์มในภายหลัง ตัวอย่าง usecase สมมติแบบย่อแสดงการจับคู่ที่มีค่าเป็นออบเจ็กต์ ไม่ใช่รายการข้อมูลจริงในขณะนั้นหรือโครงสร้างข้อมูลที่รับประกันว่าครบถ้วน ตรวจสอบทั้งสถานะ HTTP และโครงสร้าง JSON ที่คาดไว้

โครงสร้างการตอบกลับเพื่อประกอบการอธิบาย ไม่ใช่ข้อมูลบัญชีจริงในขณะนั้นหรือใบเสนอราคาปัจจุบัน

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

ข้อผิดพลาด

• 401: การยืนยันตัวตนของบัญชีล้มเหลว ตรวจสอบข้อมูลรับรอง API สถานะการเปิดใช้งาน และข้อจำกัด IP ต้นทางที่เกี่ยวข้อง
• 400/404 และข้อผิดพลาดอื่นจากหน่วยงานทะเบียน: รายการตัวเลือกหรือตัวกรองไม่ถูกต้องหรือไม่พร้อมใช้งาน เส้นทางปัจจุบันคงสถานะ HTTP และเนื้อหาการตอบกลับจากระบบต้นทางไว้ ไม่มีส่วนห่อหุ้มข้อผิดพลาด v3 แบบเดียวที่ใช้ร่วมกันทั้งหมด
• 429: ถึงขีดจำกัดคำขอของบัญชีหรือขีดจำกัดที่ใช้ร่วมกันของผู้ให้บริการแล้ว ปฏิบัติตาม Retry-After และลองใหม่โดยเพิ่มช่วงเวลารอ
• 502: ไม่สามารถติดต่อหน่วยงานทะเบียนได้ ยังไม่ทราบความพร้อมใช้งาน อย่าใช้ตัวเลือกว่างแทนแล้วถือว่าเป็นผลลัพธ์ที่สำเร็จ
• 503: ตัวจำกัดคำขอหรือบริการต้นทางไม่พร้อมใช้งาน ตรวจสอบเนื้อหาและส่วนหัว Retry-After หากมี ก่อนลองใหม่

ความพร้อมใช้งานและผลข้างเคียง

• ในเส้นทางที่ตรวจทานแล้ว คำขอ GET สำหรับรายการตัวเลือกนี้ไม่ได้สร้างแบรนด์หรือแคมเปญ ส่งการลงทะเบียน จองทรัพยากร หรือเรียกเก็บค่าธรรมเนียมการลงทะเบียน แต่มีการติดต่อผู้ให้บริการและเขียนบันทึกการตรวจสอบคำขอ
• คำจำกัดความในรายการตัวเลือกและข้อมูลเมตาค่าธรรมเนียมใด ๆ ของผู้จัดหาไม่ใช่ใบเสนอราคาขายปลีกสำหรับลูกค้า พอร์ทัลปัจจุบันดึงราคาขายปลีกของแคมเปญแยกต่างหาก ห้ามถือว่าฟังก์ชันช่วย getCampaignPrice รุ่นเก่าและคำอธิบายราคาประกอบค่ารายการแจงนับแบบเก่าเป็นข้อผูกพันด้านราคาของเส้นทางนี้
• รายการตัวเลือกที่รองรับไม่ใช่หลักฐานว่าแบรนด์ใดแบรนด์หนึ่งมีคุณสมบัติเหมาะสมกับกรณีการใช้งานนั้น ให้ดำเนินการตรวจสอบคุณสมบัติเฉพาะของแบรนด์ คำรับรอง ความยินยอม และการตรวจสอบราคาของบัญชีให้ครบถ้วน ก่อนส่งคำขอลงทะเบียนในภายหลัง