การยืนยันตัวตน
ยืนยันตัวตนคำขอ BoxHero API ด้วย Bearer token และส่งไปยัง base URL ที่มีเวอร์ชันกำกับ
API โทเค็น
หัวข้อที่มีชื่อว่า “API โทเค็น”ทุกคำขอต้องมี API โทเค็นเป็น Bearer token ในเฮดเดอร์ Authorization:
Authorization: Bearer <api-token>ออกโทเค็นได้ในแอป BoxHero ที่ การตั้งค่า > การเชื่อมต่อ โทเค็นแต่ละอันผูกกับทีมเดียว ทุกคำขอจะอ่านและเขียนข้อมูลของทีมนั้นเท่านั้น หากต้องการทำงานกับหลายทีม ให้ออกโทเค็นในแต่ละทีม
ไม่รองรับการเข้าถึงแบบไม่ระบุตัวตน เมื่อไม่มีโทเค็นหรือโทเค็นไม่ถูกต้อง ทุก endpoint จะส่งคืน 401 พร้อมโครงสร้างข้อผิดพลาด
Base URL และการกำหนดเวอร์ชัน
หัวข้อที่มีชื่อว่า “Base URL และการกำหนดเวอร์ชัน”คำขอทั้งหมดจะส่งไปที่:
https://rest.boxhero-app.comทุก endpoint อยู่ภายใต้ prefix /v1 เช่น GET /v1/items
โหมดของทีม
หัวข้อที่มีชื่อว่า “โหมดของทีม”endpoint ส่วนใหญ่ใช้ได้เฉพาะทีมที่จัดการสต็อกตามตำแหน่งจัดเก็บ สำหรับทีมอื่นจะส่งคืน 400 พร้อมประเภทข้อผิดพลาด /errors/invalid-team-mode endpoint ของทีม สมาชิก คู่ค้า และคุณสมบัติใช้ได้กับทุกทีม เรียก ดูทีมที่เชื่อมต่อ เพื่อดูว่าทีมของคุณใช้โหมดใด