เอกสารประกอบการใช้งาน API

หมวดหมู่:

หมวดหมู่:

การเชื่อมต่อและการใช้งานกับ Shifton API

The Shifton API ให้คุณเข้าถึงฟีเจอร์หลักทั้งหมดของแพลตฟอร์ม — ตั้งแต่การจัดการตารางการทำงานไปจนถึงการเชื่อมต่อกับ HR, payroll, และ ระบบวิเคราะห์ภายนอก.
โดยใช้ API คุณสามารถทำกระบวนการอัตโนมัติและเชื่อม Shifton กับบริการภายในของบริษัทของคุณได้


เอกสารประกอบ API

เราสนับสนุนเอกสารของเราในสองเวอร์ชัน:


การเริ่มต้น

รับ API Key

ในตั้งค่าบริษัทของคุณบนแพลตฟอร์ม Shifton ให้สร้าง API key.
การอนุญาตทำผ่านส่วนหัว:

Authorization: Bearer {your_api_key}

ทำการร้องขอครั้งแรกของคุณ

เช่น เพื่อดึงรายชื่อพนักงาน:

GET /api/v1/employees
Host: api2.shifton.com
Authorization: Bearer {your_api_key}

ตัวอย่างการตอบกลับ:

{
"data": [
{
"id": 101,
"name": "Alice Johnson",
"position": "HR Manager"
},
{
"id": 102,
"name": "Bob Smith",
"position": "Cashier"
}
]
}

รวม API เข้ากับกระบวนการทำงานของคุณ

  • สร้างและปรับเปลี่ยนกะการทำงานโดยอัตโนมัติ

  • จัดการคำขอลาพักร้อนและลาป่วย

  • ส่งออกข้อมูลไปยังระบบบัญชีเงินเดือน

  • สร้างแท็บเล็ตและรายงานแบบกำหนดเอง


ความสามารถหลักของ API

  • พนักงาน – เพิ่ม, แก้ไข, และจัดการบทบาท

  • ตารางเวลา – สร้าง, ปรับเปลี่ยนกะงาน, วางแผนการทำงาน

  • การลาหยุดและการขาดงาน – จัดการคำขอลาพักร้อนและลาป่วย

  • การรายงาน – ส่งออกข้อมูลเวลา, เงินเดือน, และการเข้าทำงาน


รหัสข้อผิดพลาด

Shifton API ใช้รหัสสถานะ HTTP มาตรฐาน:

  • 200 — คำขอสำเร็จ

  • 201 — การสร้างวัตถุสำเร็จ

  • 400 — พารามิเตอร์ไม่ถูกต้อง

  • 401 — ข้อผิดพลาดในการอนุญาต (คีย์ API ไม่ถูกต้อง)

  • 403 — การเข้าถึงถูกปฏิเสธ

  • 404 — ไม่พบทรัพยากร

  • 500 — ข้อผิดพลาดของเซิร์ฟเวอร์


เคล็ดลับการใช้งาน

  • ควรใช้ เวอร์ชัน API ใหม่ สำหรับการผสานรวมใหม่

  • ใช้ Postman หรือ curl สำหรับการทดสอบ

  • เคารพ ข้อจำกัดของอัตรา เพื่อหลีกเลี่ยงการถูกบล็อก

  • อัปเดตการเชื่อมต่อที่ยังคงใช้เอกสารเก่า


แชร์โพสต์นี้