Tài liệu API

Kết nối và Làm việc với API của Shifton

API Shifton cung cấp cho bạn quyền truy cập vào tất cả các tính năng chính của nền tảng — từ quản lý lịch trình đến tích hợp với các hệ thống nhân sự, , tiền lương và hệ thống phân tích .
Bằng cách sử dụng API, bạn có thể tự động hóa các quy trình và kết nối Shifton với các dịch vụ nội bộ của công ty bạn.


Tài liệu API

Chúng tôi hỗ trợ hai phiên bản tài liệu:


Bắt đầu sử dụng

Lấy mã khoá API

Trong cài đặt công ty của bạn trên nền tảng Shifton, tạo ra một mã khoá API.
Việc uỷ quyền được thực hiện thông qua tiêu đề:

Authorization: Bearer {your_api_key}

Tạo yêu cầu đầu tiên của bạn

Ví dụ, để lấy danh sách nhân viên:

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

Phản hồi ví dụ:

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

Tích hợp API vào các quy trình của bạn

  • Tự động tạo và chỉnh sửa ca làm việc

  • Quản lý các yêu cầu nghỉ phép và ốm đau

  • Xuất dữ liệu sang hệ thống tiền lương

  • Xây dựng bảng điều khiển và báo cáo tùy chỉnh


Khả Năng API Cốt Lõi

  • Nhân Viên – thêm, chỉnh sửa và quản lý vai trò

  • Lịch Trình – tạo, điều chỉnh ca làm việc, lên kế hoạch công việc

  • Nghỉ Phép & Vắng Mặt – quản lý yêu cầu nghỉ phép và nghỉ ốm

  • Báo Cáo – xuất dữ liệu giờ làm, bảng lương và điểm danh


Mã Lỗi

API Shifton sử dụng mã trạng thái chuẩn HTTP:

  • 200 — Yêu cầu thành công

  • 201 — Đối tượng được tạo thành công

  • 400 — Tham số không hợp lệ

  • 401 — Lỗi xác thực (API key không hợp lệ)

  • 403 — Không được phép truy cập

  • 404 — Không tìm thấy tài nguyên

  • 500 — Lỗi máy chủ


Mẹo Sử Dụng

  • Luôn sử dụng phiên bản API mới cho các tích hợp mới

  • Sử dụng Postman hoặc curl để kiểm tra

  • Tuân thủ giới hạn tần suất để tránh bị chặn

  • Cập nhật các tích hợp vẫn dựa vào tài liệu cũ


Chia sẻ bài viết này