ข้อมูลรับรองและสภาพแวดล้อม#
คำขอ AI API ใช้คีย์ API ที่เกี่ยวข้องกับบัญชี Ideal House API ของคุณ เก็บไว้บนเซิร์ฟเวอร์ของคุณและส่งในหัวคำขอ APIKEY
รับคีย์ API#
- เข้าสู่ระบบ คอนโซล AI API
- เปิดตัวควบคุมคีย์ API และสร้างหรือเลือกคีย์สำหรับการรวมระบบของคุณ
- เก็บคีย์ไว้ในระบบจัดการข้อมูลลับหรือการกำหนดค่าสภาพแวดล้อมฝั่งเซิร์ฟเวอร์ ห้ามบันทึกคีย์ลงในระบบควบคุมเวอร์ชันหรือรวมไว้ในชุดโค้ดที่ส่งไปยังเบราว์เซอร์
การอ่านเอกสารเหล่านี้ไม่ได้สร้างคีย์ API หรือให้สิทธิ์เข้าถึงบัญชี
กำหนดค่าสภาพแวดล้อมคำขอ#
ใช้ Base URL และเส้นทางคำขอที่ระบุใน อ้างอิง API ที่เลือก ตัวอย่างเช่น อ้างอิงที่ระบุ https://api.ideal.house ใช้โฮสต์ API นั้น ไม่ใช่ URL ของเอกสาร
เก็บคีย์ API ในตัวแปรสภาพแวดล้อมที่ใช้เฉพาะบนเซิร์ฟเวอร์ เช่น IDEALHOUSE_API_KEY นี่เป็นชื่อตัวแปรตัวอย่างสำหรับแอปพลิเคชันของคุณ ไม่ใช่การตั้งค่า SDK คำขอควรมีส่วนหัวต่อไปนี้ โดยแทนที่ค่าตัวอย่างบนเซิร์ฟเวอร์ของคุณ:
APIKEY: YOUR_API_KEY
ปฏิบัติตามประเภทเนื้อหา ฟิลด์ และรูปแบบอินพุตภาพที่จำเป็นของจุดสิ้นสุด สำหรับปฏิบัติการแบบอสังครอน ให้เก็บ ID งานที่กลับคืนมาและใช้จุดสิ้นสุดผลลัพธ์ที่ระบุไว้ในเอกสารสำหรับปฏิบัติการนั้น
การพัฒนาและโปรดักชัน#
รันการทดสอบท้องถิ่นผ่านฝั่งแบ็กเอนด์ของคุณเพื่อให้คีย์ยังคงเป็นความลับ กำหนดค่าความลับของการดีพลอยก่อนเผยแพร่ และตรวจสอบ ราคา, ขีดจำกัดงาน และ การหักเครดิต คำขอทดสอบสามารถใช้เครดิตของบัญชีได้; คู่มือเหล่านี้ไม่ได้สัญญาว่าจะมีแซนด์บ็อกซ์ฟรีแยกต่างหาก
Shop ID, Publishable Key และ Client Secret ของ การนำเข้าสินค้า สำหรับ ผู้ค้า ล้วนเป็นส่วนของการเชื่อมต่อ Visualizer SDK สิ่งเหล่านี้ไม่ได้แทนที่คีย์ AI API การตั้งค่า Allowed Origins (CORS) ในแดชบอร์ดผู้ค้าใช้สำหรับการเชื่อมต่อ Visualizer ไม่ใช่ขั้นตอนการตั้งค่าสำหรับคำขอ AI API ด้านเซิร์ฟเวอร์
ตรวจสอบการยืนยันตัวตน#
ทำตาม เริ่มต้นใช้งาน จากนั้นตรวจสอบคำตอบเฉพาะปฏิบัติการ หากการยืนยันตัวตนล้มเหลว ตรวจสอบทรี่บิวต์ APIKEY และปรึกษา รหัสข้อผิดพลาด ลบคีย์ออกจากบันทึกและภาพหน้าจอการสนับสนุน