Giới thiệu API V2.0

Mục lục

English below

API V2.0

Cùng với việc nâng cấp các tính năng sản phẩm của ClassIn, API của ClassIn đã được cập nhật lên phiên bản v2.0.

So với API ClassIn trước đây (v1), điểm khác biệt chính khi gọi API này là:

  1. Kiểu định dạng URL API đã thay đổi. Liên kết không còn chứa tham số (action=) nữa, và API được sử dụng được xác định bởi các đường dẫn khác nhau.
  2. JSON sẽ được sử dụng làm định dạng trao đổi dữ liệu, thay vì các biểu mẫu. Điều này có nghĩa là các lệnh gọi phải là Content-Type: application/json.
  3. Quá trình xác thực bảo mật sử dụng tham số chữ ký mới: X-EEO-SIGN, thay thế cho safeKey. Tham số này được đặt trong phần tiêu đề, không phải phần thân. Vui lòng nhấp vào đây để xem các quy tắc tạo chữ ký.
  4. Trong phiên bản v2.0, timestamp vẫn là tham số bắt buộc, nhưng thời gian hết hạn đã được thay đổi từ 20 phút xuống còn 5 phút.
  5. Định dạng dữ liệu phản hồi cho phiên bản v2.0 là JSON, nhưng có một số khác biệt so với cấu trúc dữ liệu JSON trước đó. Mã trả về hiện nằm ở tham số cấp một (code), thay vì tham số cấp hai (error_info -> error_code).

Mối quan hệ giữa API v1 và API V2.0

Tất cả các API mới được hỗ trợ sau tháng 8 năm 2024 đều ở định dạng API v2.0; các API trước đó vẫn sẽ sử dụng định dạng API v1. Trong tương lai, các API v1 sẽ được cập nhật dần lên định dạng v2.0.

Những giao diện nào sử dụng API V2.0

Hiện tại, tất cả các giao diện trong thư mục LMS đều sử dụng API v2. Các giao diện trong các thư mục khác, bao gồm đăng ký người dùng và tạo lớp học, vẫn sử dụng API v1 ban đầu. Vui lòng tham khảo tài liệu của từng giao diện để biết thêm chi tiết. Chúng tôi
hiện đang trong giai đoạn chuyển đổi giữa phiên bản cũ và mới, vì vậy việc tích hợp hoàn chỉnh thường sẽ bao gồm việc gọi các giao diện từ cả hai phiên bản.

Nếu bạn muốn tạo một bài học, thứ tự gọi API được khuyến nghị là gì?

Luồng khuyến nghị sẽ bao gồm các giai đoạn từ tích hợp dữ liệu người dùng, tạo lớp học, tạo chương và tạo buổi học, cũng như đăng ký nhận dữ liệu tóm tắt sau giờ học (thu thập điểm danh):

Nếu bạn muốn thêm hoặc xóa học viên cho một khóa học cụ thể, bạn có thể gọi [tên hàm].

Lưu ý: Đoạn mã trên sử dụng một số giao diện v1 và một số giao diện v2. Sự khác biệt trong các phương thức gọi của hai phiên bản đã được giải thích trong bài viết này.

About API v2

With the upgrade of ClassIn product features, the ClassIn API has launched version v2.

Here are the main differences compared to the previous ClassIn API (v1):

  1. Interface URL Change: The URL no longer includes parameters (action=). Instead, different paths determine which interface is used.

  2. Data Format: JSON is now the standard format for data exchange, replacing form data. Requests must include Content-Type: application/json.

  3. Security Verification: The new signature parameter, X-EEO-SIGN, replaces the original safeKey. This parameter is included in the header instead of the body. For signature rules, please click here.

  4. Timestamp Requirement: In v2, the timestamp is still required, but the expiration time has reduced from 20 minutes in v1 to 5 minutes in v2.

  5. Response Data Format: The response format is now JSON, but it differs slightly from the previous version. The error code is now at the top-level (code), instead of being nested under error_info -> errno.

What is the Relationship Between API v1 and API v2?

Starting in August 2024, all new interfaces will use the API v2 format, while existing interfaces will continue to operate under API v1.

In the future, we will gradually update the v1 interfaces to the v2 format.

Which Interfaces Use API v2?

Currently, all interfaces in the LMS directory are using API v2. However, other interfaces, such as user registration and class(course) creation, still use the original API v1.

For specific details, please check the documentation for each interface.

During this transition period, complete system integration will usually involve calls to both versions of the API.

Recommended API Call Sequence for Creating an Interactive Online Classroom

To create an online classroom, it is recommended to follow this sequence of API calls:

If you want to add or remove a students from a classroom activity, you can use:

Note: The interfaces mentioned above include both old and new versions. This document explains the differences in how to call each version.