Bắt đầu

Giới thiệu

API làm được gì, hai kiểu ứng dụng, điều kiện.

CTAS Work là ứng dụng chấm công, nhân sự, lịch làm việc và lương cho doanh nghiệp. API cho phép phần mềm của bạn (POS, ERP, kế toán, máy chấm công…) đọc và ghi dữ liệu của những tổ chức đã cho phép, và nhận thông báo khi dữ liệu thay đổi.

Bạn làm được gì

  • Đọc phòng ban, chức danh, nhân sự. Tạo và cập nhật nhân sự.
  • Đọc chấm công và lịch làm việc theo khoảng ngày. Duyệt đơn nghỉ.
  • Kích hoạt một lượt việc trong Quy trình kèm dữ liệu điền sẵn.
  • Xác nhận nhân sự bằng mã QR: phần mềm của bạn hiện mã QR, nhân viên quét bằng ứng dụng CTAS Work, bạn nhận về mã nhân sự của người đó. Không cần tự dựng đăng nhập cho nhân viên.
  • Nhận webhook có chữ ký cho mọi thay đổi ở trên.

Hai kiểu ứng dụng

Ứng dụng nội bộỨng dụng nền tảng
Bạn làdoanh nghiệp tự nối hệ thống của mình với CTAS Worknhà cung cấp phần mềm có nhiều khách hàng dùng CTAS Work
Kết nối tớichính tổ chức của bạn, tự độngtừng tổ chức khách hàng, khi họ đồng ý
Cần CTAS duyệtkhôngcó, trước khi kết nối tổ chức ngoài tổ chức của bạn

Cùng một API cho cả hai. Khác nhau chỉ ở cách tổ chức kết nối vào.

Ứng dụng nội bộ có thể chuyển thành ứng dụng nền tảng khi bạn cần kết nối thêm tổ chức khác (ví dụ bên nhượng quyền nối tới các cửa hàng nhận quyền): vào trang ứng dụng › mục Phát hành › Chuyển thành ứng dụng nền tảng. Client ID, khoá bí mật, webhook và kết nối của tổ chức bạn giữ nguyên. Chỉ chuyển một chiều. Sau khi chuyển, client_credentials chỉ còn dùng để quản lý webhook; đọc dữ liệu đi bằng token của từng kết nối.

Điều kiện

"Gói có API" là các gói CTAS Work có tính năng API theo bảng giá hiện hành. Console ghi rõ tổ chức của bạn đang ở gói nào và có dùng được API không.

Thử nghiệmChính thức
Tài khoản tạo ứng dụng là quản trị viên của một tổ chức ở gói có APIbắt buộcbắt buộc
Tổ chức được kết nối ở gói có APIkhông cần, dùng tổ chức thử nghiệmbắt buộc, trừ khi ứng dụng được bảo trợ kết nối
Ứng dụng nền tảng đã được duyệt phát hànhkhông cầnbắt buộc để kết nối tổ chức khác
Giới hạn mặc định300 yêu cầu/phút mỗi ứng dụng · 60/phút mỗi kết nối3.000/phút mỗi ứng dụng · 600/phút mỗi kết nối

Bảo trợ kết nối: với ứng dụng mà chủ sở hữu chịu chi phí cho các tổ chức nó kết nối (bên nhượng quyền và các cửa hàng nhận quyền), CTAS bật bảo trợ khi duyệt phát hành. Khi đó điều kiện về gói xét trên tổ chức sở hữu ứng dụng, tổ chức được kết nối dùng gói nào cũng được. Nếu gói của tổ chức sở hữu hết hạn, mọi kết nối được bảo trợ nhận 403 PLAN_REQUIRED với details.reason = sponsor_unavailable cho tới khi gia hạn; kết nối không bị xoá. Liên hệ CTAS để đăng ký.

Không có API nào trả về giấy tờ tuỳ thân, tài khoản ngân hàng, từng dòng của phiếu lương, hay thông tin đăng nhập của nhân viên. Phiếu lương chỉ ra ngoài ở dạng số tổng, với quyền payroll:read (xem Bảng lương).