สร้างและส่งคีย์ API
ทุกคำขอที่คิดค่าบริการยืนยันตัวตนด้วยคีย์ API ที่ส่งเป็นเฮดเดอร์ สร้างคีย์ในแดชบอร์ด ส่งคีย์ไปกับทุกคำขอ และกำหนดวงเงินที่แต่ละคีย์ใช้ได้
ทุกคำขอที่คิดค่าบริการของ Paxa API ยืนยันตัวตนด้วยคีย์ API ที่ส่งเป็นเฮดเดอร์ คีย์ขึ้นต้นด้วย pxa_ และผูกกับบัญชีของคุณ คำขอที่ไม่มีคีย์ที่ใช้งานได้จะตอบกลับเป็น 401 unauthorized ส่วนเอนด์พอยต์แคตตาล็อก (โมเดล, เสียง) และสถานะระบบ เป็นสาธารณะ ไม่ต้องใช้คีย์
สร้างคีย์#
สร้างคีย์ได้ที่หน้าคีย์ API ในแดชบอร์ด ระบบแสดงคีย์เต็มเพียงครั้งเดียวตอนสร้าง และเก็บเฉพาะค่าแฮชไว้ จึงเรียกดูคีย์ซ้ำไม่ได้ แต่ละบัญชีมีคีย์ได้สูงสุด 20 คีย์ นับรวมคีย์ที่ปิดใช้งานด้วย
ส่งคีย์#
ส่งคีย์ในเฮดเดอร์ Authorization ด้วยรูปแบบ Bearer หรือส่งในเฮดเดอร์ x-api-key ก็ได้ หากส่งมาทั้งคู่ ระบบใช้ Authorization เป็นหลัก และถ้า Authorization มีรูปแบบไม่ถูกต้อง คำขอจะถูกปฏิเสธทันทีโดยไม่ย้อนไปอ่าน x-api-key
curl https://api.paxalabs.com/v1/me \
-H "Authorization: Bearer $PAXA_API_KEY"curl https://api.paxalabs.com/v1/me \
-H "x-api-key: $PAXA_API_KEY"กำหนดวงเงินต่อคีย์#
แต่ละคีย์กำหนดวงเงินเครดิตได้ ตั้งได้ตั้งแต่ตอนสร้างหรือแก้ไขภายหลังในแดชบอร์ด เมื่อคีย์ใช้เครดิตครบตามวงเงิน คำขอของคีย์นั้นจะตอบกลับเป็น 403 key_limit โดยไม่คิดเครดิตเพิ่ม ควรออกคีย์แยกพร้อมวงเงินให้แต่ละสภาพแวดล้อมและแต่ละคนในทีม
ปิดใช้งานหรือลบคีย์#
การปิดใช้งานคีย์ย้อนกลับได้ คำขอที่ใช้คีย์นั้นจะตอบกลับเป็น 401 จนกว่าจะเปิดใช้งานอีกครั้ง ส่วนการลบคีย์เป็นการถาวรและมีผลทันที ประวัติการใช้งานที่บันทึกไว้แล้วยังคงอยู่ในบัญชี
ข้อควรระวัง
คีย์เป็นข้อมูลลับ ควรเรียก API จากฝั่งเซิร์ฟเวอร์และเก็บคีย์ในตัวแปรแวดล้อม คีย์ที่ฝังในโค้ดฝั่งผู้ใช้ถือว่าเปิดเผยแล้ว หากคีย์รั่วไหล ให้สร้างคีย์ใหม่แล้วลบคีย์เดิมทิ้ง