Để biết thông số kỹ thuật chi tiết cần thiết cho việc tích hợp hệ thống, vui lòng xem Tài liệu ở đây.
https://docs.api.teachme.jp
※Tài liệu được soạn thảo bằng tiếng Nhật.
Vui lòng tự dịch khi cần thiết.
Tổng quan
Kết nối API là cơ chế để gọi thông tin quy trình từ các hệ thống hoặc ứng dụng bên ngoài.
Bằng cách sử dụng API, bạn có thể truy cập thông tin quy trình không chỉ từ Teachme Biz mà còn từ các hệ thống bên ngoài.
Gói hỗ trợ
Vui lòng xem liên kết để biết các gói và Tùy chọn có thể sử dụng tính năng này.
Chi tiết
Thông tin có thể lấy qua API là nội dung văn bản của các Quy trình đã được công khai.
Không thể tạo, chỉnh sửa hoặc Xóa quy trình qua API.
API danh sách quy trình
Bạn có thể lấy danh sách các quy trình đã được đăng ký.
Mỗi lần gọi, có thể lấy tối đa 100 mục.
Bạn có thể lấy tất cả quy trình bằng cách gọi tiếp theo dưới dạng Trang sau.
Khi chỉ định từ khóa, hệ thống sẽ lấy tối đa 100 quy trình liên quan theo thứ tự mức độ liên quan (không có Trang sau).
Thông tin có thể lấy cho mỗi quy trình bao gồm: ID quy trình, URL, Tiêu đề, mô tả trang bìa và Thư mục chứa quy trình.
API chi tiết quy trình
Bạn có thể lấy Thông tin chi tiết cho từng quy trình.
Ngoài thông tin có thể lấy qua API danh sách, bạn còn có thể lấy nội dung các Bước và các trường tùy chỉnh của trang bìa và Bước.
Đối với các Nhóm sử dụng tính năng dịch tự động, bạn cũng có thể lấy nội dung đã được dịch bằng cách chỉ định ngôn ngữ.
Thông tin có thể lấy
- ID quy trình, URL của quy trình
- Tiêu đề, mô tả trang bìa
- Tiêu đề Bước, mô tả Bước (chỉ dành cho API chi tiết quy trình)
- Tên mục và nội dung nhập của các trường tùy chỉnh trên trang bìa và Bước (chỉ dành cho API chi tiết quy trình)
- Tên và cấp bậc của Thư mục chứa quy trình
Thông tin không thể lấy
- Hình ảnh và video của trang bìa và Bước
- Đánh dấu trên hình ảnh hoặc video, phụ đề của video
- Quy trình liên quan, Liên kết bên ngoài và Dữ liệu địa điểm trên trang bìa
- Quy trình ở trạng thái nháp
- Các thông tin quản lý quy trình như số lượt xem, người tạo, ngày cập nhật, v.v.
- Các thông tin ngoài quy trình như Người dùng và Đào tạo
Liên kết liên quan
Issue and Delete Client IDs for API Integration (Web Browser)
Điều khoản bổ sung Teachme Biz API Access Plus
Tiếng Nhật：https://file.biz.teachme.jp/doc/teachmebiz_apiaccessplus_supplemental_terms.pdf
Tiếng Anh：https://file.biz.teachme.jp/doc/teachmebiz_apiaccessplus_supplemental_terms_e.pdf
Câu hỏi thường gặp
Q. Có thể kết nối với những công cụ bên ngoài nào?
A. Về mặt lý thuyết, bất kỳ hệ thống nào có thể gọi và nhận API đều có thể kết nối, bao gồm các hệ thống tự phát triển, chatbot thương mại, công cụ AI tạo sinh, v.v.
Q. Có giới hạn nào đối với thông tin có thể lấy qua API không?
A. Có.
Thông tin có thể lấy được giới hạn trong phạm vi mà Người dùng đã phát hành khóa API có thể xem.
Không thể lấy các quy trình mà Người dùng đã phát hành khóa API không có quyền xem.
Q. Có thể đặt Ngày hết hạn cho khóa API đã phát hành và cài đặt kết nối không?
A. Có thể cài đặt Ngày hết hạn theo nhiều mức, và cũng có thể đặt không giới hạn thời gian.
Tuy nhiên, cần lưu ý rằng nếu Người dùng đã phát hành khóa API bị Xóa khỏi Nhóm, kết nối sẽ bị dừng.
Để tránh việc Kết nối API bị dừng ngoài ý muốn, chúng tôi khuyến nghị bạn tạo một Người dùng riêng dành cho việc phát hành khóa API.
Q. Có thể cài đặt nhiều khóa API vào hệ thống của mình không?
A. Có.
Ví dụ, bạn có thể phát hành các khóa API với phạm vi tìm kiếm quy trình được xác định theo từng phòng ban và kết nối với từng hệ thống tương ứng.
Q. Trong môi trường có giới hạn địa chỉ IP, có thể sử dụng API để tìm kiếm quy trình từ mạng không được phép không?
A. Có.
API không bị ảnh hưởng bởi giới hạn địa chỉ IP.
Q. Khi lấy thông tin quy trình qua API, lượt truy cập có được tính vào số lượt xem của quy trình đó không?
A. Không.
Việc tìm kiếm và lấy thông tin quy trình qua API không được tính vào số lượt xem của quy trình.
Q. Có thể nhận hỗ trợ kỹ thuật trong quá trình triển khai không?
A. Việc kết nối với hệ thống cần được thực hiện bởi phía khách hàng.
Q. Có hỗ trợ MCP (Model Context Protocol) không?
A. Không, chúng tôi không hỗ trợ.
Bằng cách xây dựng và triển khai chương trình gọi API trong hệ thống hoặc AI tạo sinh mà bạn đang sử dụng ở phía Người dùng, bạn có thể tìm kiếm và tham chiếu thông tin quy trình từ AI tạo sinh.