การยืนยันตัวตนและคีย์ API

Public API ใช้คีย์ API แบบ Bearer ที่ขึ้นต้นด้วย spk_

Authorization: Bearer spk_...

การกำหนดขอบเขตระดับแบรนด์

คีย์ API แต่ละชุดจะถูกกำหนดให้ใช้กับแบรนด์เดียวเท่านั้น คีย์จะเป็นตัวระบุแบรนด์เป้าหมายของ Endpoint /v1/brand/* และคุณไม่สามารถระบุแบรนด์อื่นในเนื้อหาคำขอได้

เฉพาะเจ้าของแบรนด์เท่านั้นที่สร้างและออกคีย์ API ได้

ขอบเขตสิทธิ์และสิทธิ์การใช้งาน

การตรวจสอบสิทธิ์ของแต่ละ Endpoint อ้างอิงขอบเขตสิทธิ์ต่อไปนี้:

brands:read, brands:write
connections:read
publishing:read, publishing:write
comments:read, comments:write, comments:moderate
analytics:read
webhooks:read, webhooks:write

หากคีย์ API ไม่มีขอบเขตสิทธิ์ที่จำเป็น เซิร์ฟเวอร์จะส่งคืน 403 insufficient_scope

Endpoint ที่ไม่ต้องยืนยันตัวตน

/
/v1/health
/v1/docs
/v1/openapi.json

โควตาตามแผนบริการ

แบรนด์ในแผน Free มีคีย์ API ที่ใช้งานอยู่ได้ 1 ชุด และเรียก API ได้ 1,000 ครั้งต่อเดือนปฏิทิน (UTC) แบรนด์ในแผน Growth ใช้คีย์ API ได้หลายชุดภายใต้นโยบายการใช้งานอย่างเป็นธรรม

ทั้งคำขอที่สำเร็จและไม่สำเร็จหลังจากยืนยันตัวตนถูกต้องจะนับรวมในโควตาของแผน Free ส่วนการตรวจสอบสถานะ เอกสาร API การเรียกสคีมา OpenAPI และคำขอที่ใช้คีย์ไม่ถูกต้องจะไม่นับรวม

คำแนะนำด้านความปลอดภัย

เก็บคีย์ไว้ในตัวแปรสภาพแวดล้อมหรือบริการจัดการข้อมูลลับ
ห้ามใส่คีย์ไว้ในโค้ดฝั่งไคลเอนต์หรือเบราว์เซอร์
ปิดบังคีย์ในบันทึกการทำงาน
เพิกถอนคีย์ที่ไม่ได้ใช้และหมุนเวียนคีย์เป็นประจำ
ใช้คีย์แยกกันสำหรับสคริปต์อัตโนมัติแต่ละชุด เพื่อให้แยกประวัติการใช้งานได้