การยืนยันตัวตน

รูปแบบคีย์#

esk_live_<prefix:10>_<secret:40>

คีย์เป็นสตริงตัวอักษรและตัวเลข ประกอบด้วยคำนำหน้า 10 ตัวอักษร (ตัวระบุสาธารณะที่แสดงในพอร์ทัล) และรหัสลับ 40 ตัวอักษร esimoa เก็บเฉพาะแฮช SHA-256 คีย์เต็มจึงแสดงเพียงครั้งเดียวตอนออกคีย์และกู้คืนไม่ได้

Sending the key#

ส่งคีย์ในเฮดเดอร์ X-API-Key ทุกคำขอ และรองรับ Authorization: Bearer ด้วย หากไม่มีคีย์จะได้ 401 API_KEY_REQUIRED และหากคีย์ผิดรูปแบบหรือไม่รู้จักจะได้ 401 INVALID_API_KEY

# Preferred
X-API-Key: esk_live_AbCdE12345_<40-character secret>

# Also accepted
Authorization: Bearer esk_live_AbCdE12345_<40-character secret>

Issuing keys#

1. 1พอร์ทัลพาร์ตเนอร์ → คีย์ API — สร้างคีย์ใหม่
2. 2ตั้งชื่อ และกำหนดวันหมดอายุ (ระหว่าง 1 นาทีถึง 3 ปีนับจากนี้) และรายการ IP ที่อนุญาตได้ตามต้องการ
3. 3คัดลอกคีย์ทันที — คีย์จะแสดงเพียงครั้งเดียว — และเก็บไว้ในตัวจัดการข้อมูลลับหรือตัวแปรสภาพแวดล้อมของเซิร์ฟเวอร์

โดยค่าเริ่มต้น แต่ละบัญชีมีคีย์ที่ใช้งานอยู่ได้สูงสุด 5 คีย์ (คีย์ที่ไม่ถูกเพิกถอนและยังไม่หมดอายุ)

Rotating keys#

การหมุนเวียนจะสร้างคีย์ใหม่ที่มีชื่อ ขอบเขต รายการ IP ที่อนุญาต และวันหมดอายุเหมือนเดิม คีย์เดิมยังใช้งานได้ตลอดช่วงผ่อนผันที่คุณเลือก (0–72 ชั่วโมง) แล้วจึงหมดอายุ — ให้นำคีย์ใหม่ไปใช้ภายในช่วงเวลานั้น ช่วงผ่อนผัน 0 จะตัดคีย์เดิมทันที

IP allowlist#

แต่ละคีย์จำกัดได้สูงสุด 20 ที่อยู่ IPv4/IPv6 หรือช่วง CIDR (เช่น 203.0.113.10, 198.51.100.0/24) รายการว่างหมายถึงไม่จำกัด คำขอจากที่อื่นจะได้รับ 403 IP_NOT_ALLOWED โปรดใช้ IP ขาออกของเซิร์ฟเวอร์ของคุณ

Revoking keys#

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

Member roles#

เฉพาะสมาชิก OWNER, ADMIN และ DEVELOPER เท่านั้นที่ออก หมุนเวียน หรือเพิกถอนคีย์ได้ สมาชิกทุกคนดูรายการคีย์ได้