คีย์ API
ในหน้านี้
คีย์ API ช่วยให้ซอฟต์แวร์ของคุณเอง — หรือระบบของบุคคลที่สามใดก็ได้ที่รองรับ BYOK (Bring Your Own Key) — ใช้โมเดลที่ Performance Hub เผยแพร่ได้ คีย์จัดการได้ใน Settings (เฟือง) → Service Access & API Keys คุณต้องเป็น Organisation Administrator จึงจะจัดการคีย์ได้
"สร้าง API keys เพื่อให้ซอฟต์แวร์และระบบของบุคคลที่สามที่รองรับ BYOK (Bring Your Own Key) สามารถเชื่อมต่อกับ Models ที่เผยแพร่โดย Performance Hub ได้"
รูปที่ 1: รายการคีย์ API: ป้ายกำกับ คีย์ที่ปิดบังไว้ สถานะ ค่าใช้จ่ายและขีดจำกัด โมเดล การใช้งานล่าสุด และการดำเนินการในแต่ละแถว
รายการคีย์
| คอลัมน์ | ความหมาย |
|---|---|
| Label | ชื่อที่คุณตั้งให้คีย์ (ไม่บังคับ) |
| Key | คีย์ที่ปิดบังไว้ (เช่น phk_7Qm2…Xa9LkP) — ข้อมูลลับฉบับเต็มจะไม่แสดงอีกเลยหลังจากสร้าง |
| Status | Active, Provisioning… (ช่วงสั้น ๆ ขณะตั้งค่าคีย์ใหม่) หรือ Disabled (ถูกเพิกถอน แถวจะจางลง) |
| Spend / limits | ค่าใช้จ่ายตลอดอายุการใช้งาน และความคืบหน้าเทียบกับขีดจำกัดค่าใช้จ่ายที่ตั้งไว้กับคีย์ |
| Models | all หรือจำนวนโมเดลที่คีย์ถูกจำกัดให้ใช้ |
| Last used | เวลาที่คีย์ส่งคำขอล่าสุด |
| Actions | Edit, Rotate, Revoke (หรือ Re-activate), Delete |
หากคุณใช้ Workflows แถว Workflows จะแสดง Managed service แทนคีย์ที่ปิดบังไว้ หากไม่มีคีย์เลย รายการจะแสดง "No API keys yet."
การสร้างคีย์
คลิก Create key ลิ้นชัก Create API key จะเปิดขึ้น:
รูปที่ 2: ลิ้นชัก Create API key: ป้ายกำกับ ประเภทการเชื่อมต่อ ขีดจำกัดค่าใช้จ่าย ขีดจำกัดอัตรา การจำกัดโมเดล และการแทนที่ Guardrails
| การตั้งค่า | ลักษณะการทำงาน |
|---|---|
| Label (optional) | ชื่อของคีย์ ซึ่งมักเป็นชื่อระบบที่ใช้คีย์นั้น (เช่น Hotel Concierge App, Clinic Intake Assistant หรือ Booking Website) แนะนำอย่างยิ่ง — ป้ายกำกับเป็นสิ่งที่ใช้ระบุที่มาของการใช้งานใน Activity และ Logs |
| Connection type | API key — "Generic API keys remain in the API Keys list." External agent — "External agents appear under Connected Services and use this key to authenticate." กำหนดเมื่อสร้างคีย์และเปลี่ยนแปลงภายหลังไม่ได้ |
| Set spend limits for this key | "Set any combination of daily, monthly and lifetime caps for this key." — Daily limit ("Resets at the start of each day (facility timezone)."), Monthly limit ("Resets on the 1st of each month (facility timezone).") และ Lifetime cap ("Total spend over the lifetime of this key. Never resets.") |
| Rate limits (optional) | "Cap requests and tokens per minute for this key. Leave blank for unlimited." — Requests / min และ Tokens / min |
| Restrict models for this key | "Only the selected models will be usable with this key." เลือกจากโมเดลที่เปิดใช้งานของสถานที่ |
| Override facility guardrails for this key | "Select none to explicitly disable guardrails for this key." เมื่อเปิดใช้งาน คีย์นี้จะใช้การเลือก Guardrails ของตนเองแทนของสถานที่ — รวมถึง "none" ดู Guardrails |
คลิก Create key
ข้อมูลลับที่แสดงเพียงครั้งเดียว
คีย์ใหม่จะแสดงเพียงครั้งเดียวในกล่องโต้ตอบ Copy your API key:
รูปที่ 3: คีย์ใหม่จะแสดงเพียงครั้งเดียว: คัดลอกคีย์ก่อนปิดกล่องโต้ตอบ
"นี่เป็นครั้งเดียวเท่านั้นที่จะแสดงคีย์เต็มรูปแบบ โปรดเก็บรักษาไว้ในที่ปลอดภัย"
คัดลอกคีย์ไปไว้ในตัวจัดการข้อมูลลับของคุณก่อนคลิก Done หลังจากปิดกล่องโต้ตอบนี้ จะแสดงเฉพาะรูปแบบที่ปิดบังไว้เท่านั้น หากคุณทำข้อมูลลับหาย ให้ Rotate คีย์เพื่อรับคีย์ใหม่
การแก้ไขคีย์
คลิกแถวของคีย์ (หรือไอคอนดินสอ Edit) เพื่อเปิดลิ้นชัก Configure API key — ซึ่งมีการตั้งค่าเดียวกับตอนสร้าง (ป้ายกำกับ ขีดจำกัดค่าใช้จ่าย ขีดจำกัดอัตรา การจำกัดโมเดล การแทนที่ Guardrails):
รูปที่ 4: ลิ้นชัก Configure API key
การเปลี่ยนแปลงจะมีผลภายในไม่กี่วินาทีหลังจากบันทึก เมื่อคีย์มีขีดจำกัดรายวัน/รายเดือน แถวของคีย์จะแสดงการใช้งานเทียบกับขีดจำกัดนั้น (Today, This month, Lifetime) และป้าย Limit reached เมื่อถึงขีดจำกัด
วงจรของคีย์: หมุนเวียน เพิกถอน ลบ
การดำเนินการแต่ละอย่างมีกล่องโต้ตอบยืนยันที่ระบุสิ่งที่จะเกิดขึ้นอย่างชัดเจน:
| การดำเนินการ | ผลลัพธ์ | ข้อความยืนยัน |
|---|---|---|
| Rotate | ออกข้อมูลลับใหม่ (แสดงเพียงครั้งเดียว) ด้วยการตั้งค่าเดิม ข้อมูลลับเดิมจะใช้งานไม่ได้ทันที | "A new key will be issued and the current key will stop working immediately." "You will need to reconfigure any services still using the old key. This cannot be undone." |
| Revoke | ปิดใช้งานคีย์ทันทีโดยย้อนกลับได้ | "This key will be disabled immediately and any services using it will stop working. You can re-activate it again later." |
| Re-activate | กู้คืนคีย์ที่ถูกเพิกถอน (ข้อมูลลับเดิม) | ไม่มี — ดำเนินการทันที |
| Delete | ลบคีย์อย่างถาวร | "This permanently deletes the key and any services using it will stop working. This cannot be undone." |
รูปที่ 5: การยืนยัน Delete API key
ควรใช้แบบใด: หมุนเวียนเมื่อสงสัยว่ามีการรั่วไหล (บริการยังคงการตั้งค่าและประวัติไว้ เพียงอัปเดตข้อมูลลับ) เพิกถอนเพื่อหยุดระบบชั่วคราว และลบเฉพาะเมื่อเลิกใช้การผสานรวมนั้นอย่างถาวร
การเชื่อมต่อด้วยคีย์
การ์ด Connecting to the API ใต้รายการคีย์จะแสดง base URL และตัวอย่างคำขอที่คัดลอกไปวางได้สำหรับสภาพแวดล้อมของคุณ ดู การเชื่อมต่อแอปพลิเคชันของคุณ สำหรับคู่มือเริ่มต้นอย่างรวดเร็วฉบับเต็มพร้อมตัวอย่าง SDK และการจัดการข้อผิดพลาด