เริ่มต้นที่นี่

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

ใช้ API key ฝั่งเซิร์ฟเวอร์สำหรับการเชื่อมต่อผลิตภัณฑ์ และเซสชันเบราว์เซอร์สำหรับการดูแลเวิร์กสเปซ

API keys

ยืนยันตัวตนคำขอ API ของลูกค้าด้วย Authorization: Bearer re_… คีย์เป็นของเวิร์กสเปซเดียว และห้ามฝังไว้ในเบราว์เซอร์ มือถือ เดสก์ท็อป เทมเพลต หรือเนื้อหาอีเมลโดยเด็ดขาด

เฮดเดอร์คำขอ
Authorization: Bearer re_your_key_here

เซสชันเบราว์เซอร์

แดชบอร์ดใช้คุกกี้เซสชันแบบ HTTP-only ที่เพิกถอนได้ การเปลี่ยนแปลงการเรียกเก็บเงินและการสร้างหรือเพิกถอน API key ต้องใช้เซสชันเบราว์เซอร์นี้ และ bearer key ใช้ไม่ได้ bearer key อ่านข้อมูลบัญชี การใช้งาน และสถานะการเรียกเก็บเงินเดียวกันได้ผ่าน GET /account อ่าน analytics ของแดชบอร์ดผ่าน GET /analytics และอ่านเมทาดาทาของคีย์ (ชื่อ พรีฟิกซ์ การใช้ล่าสุด) ผ่าน GET /keys

การหมุนเวียนคีย์

  1. สร้างคีย์ใหม่ทดแทนจากเซสชันแดชบอร์ดที่ยืนยันตัวตนแล้ว
  2. นำคีย์ใหม่ไปใช้กับทุกบริการที่เรียก
  3. ยืนยันว่าทราฟฟิกใช้พรีฟิกซ์ใหม่
  4. เพิกถอนคีย์เก่า

ความล้มเหลวของการยืนยันตัวตน

ข้อมูลรับรองที่ไม่มี หมดอายุ ถูกเพิกถอน หรือไม่รู้จัก จะได้รับ 401 ในซองข้อผิดพลาดมาตรฐาน อย่าลองใหม่โดยอัตโนมัติเมื่อการยืนยันตัวตนล้มเหลว

การตอบกลับ 401
{
  "error": {
    "message": "Unauthorized — provide a valid API key or session",
    "status": 401
  }
}