สร้าง API Key และเรียก API

Key ผูกกับ Project เดียว แสดงครั้งเดียวตอนสร้าง และกำหนดได้ว่าทำอะไรได้บ้าง

  1. ในหน้า Integrations กด สร้าง API Key
  2. ตั้งชื่อให้รู้ว่าระบบไหนใช้ เช่น pos-สาขาสยาม
  3. เลือกสิทธิ์: อ่าน หรือ อ่านและแก้ไข ของแต่ละ API (สิทธิ์แก้ไขสร้างได้เฉพาะ Owner หรือ Admin ของ Project)
  4. ถ้าเป็น Wi-Fi เลือกจำกัดเฉพาะบางสถานที่ได้ และตั้งวันหมดอายุได้ถ้าต้องการ
  5. กด สร้าง API Key แล้วคัดลอก Key เก็บไว้ทันที ระบบแสดงครั้งเดียว
Shell
curl -H "Authorization: Bearer thk_YOUR_KEY" https://api.thailandhosting.com/v1/key

GET /v1/key บอกว่า Key นี้อยู่ Project ไหนและมีสิทธิ์อะไร ไม่คิดค่าเรียก ใช้ทดสอบการตั้งค่าได้

อย่าใส่ API Key ในหน้าเว็บหรือแอปที่ลูกค้าดาวน์โหลดได้ ให้เรียก API จากเซิร์ฟเวอร์ของคุณเท่านั้น ถ้า Key หลุด ให้ลบทิ้งแล้วสร้างใหม่

Error ที่ได้ความหมาย
401 invalid_keyKey ผิด ถูกลบ หรือหมดอายุ
403 insufficient_scopeKey ไม่มีสิทธิ์ทำสิ่งนี้ เช่น Key อ่านอย่างเดียวพยายามแก้ไข
403 api_disabledAPI นี้ยังไม่ได้เปิดใน Integrations ของ Project
402 payment_requiredใช้ครั้งฟรีของเดือนหมดแล้วและ Wallet ของ Project ไม่มีเงิน
429 rate_limitedเรียกถี่เกินไป รอตามจำนวนวินาทีใน header Retry-After แล้วลองใหม่

Error ทุกตัวเป็น JSON แบบ Problem Details (RFC 9457) มี code ให้โปรแกรมตรวจ และ detail บอกรายละเอียด

ถ้าเจอปัญหา

ปุ่มสร้าง API Key กดไม่ได้

ต้องเปิด API อย่างน้อย 1 ตัวใน Integrations ก่อน

สร้าง Key ที่แก้ไขข้อมูลได้ไม่ได้

สิทธิ์แก้ไขสร้างได้เฉพาะ Owner หรือ Admin ของ Project ให้คนที่มีบทบาทนั้นสร้างให้

Key ที่เคยใช้ได้ ตอนนี้ขึ้น 401

Key หมดอายุ ถูกลบ หรือคนที่สร้างออกจาก Project ไปแล้ว (Key ของเขาหมดอายุทันที) ให้สร้าง Key ใหม่

ยังแก้ไม่ได้? ให้ทีมงานช่วย

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