Open API
Gọi tác nhân từ hệ thống của bạn
Hệ thống ticket, CRM và công cụ nội bộ có thể gọi các tác nhân và quy trình làm việc bạn đã xuất bản trong Evose. Chờ kết quả, hoặc lấy ngay mã lần chạy và nhận callback khi xong.
Kết nối với hệ thống bạn đang có
Gọi những gì đội ngũ đã xây dựng
Mọi tác nhân, Tác nhân điều phối hay quy trình làm việc mà đội ngũ đã xuất bản trong Evose đều gọi được qua API. Lệnh gọi luôn dùng phiên bản xuất bản mới nhất, nên khi câu lệnh thay đổi trong Evose, mã của bạn không phải đổi theo.
Không phải chờ tác vụ dài
Bắt đầu một lần chạy bất đồng bộ và nhận ngay mã lần chạy. Truy vấn kết quả theo mã, hoặc truyền URL callback để kết quả được gửi về khi xong.
Mỗi khóa cho một việc
Mỗi khóa API chỉ gọi được các ứng dụng bạn chọn. Đặt ngày hết hạn và tắt khóa bất cứ lúc nào.
Từ xuất bản đến lệnh gọi đầu tiên
- 01
Xuất bản ứng dụng
Xây dựng một tác nhân, Tác nhân điều phối hoặc quy trình làm việc trong Evose. Sau khi xuất bản, bạn có thể gọi nó qua API.
- 02
Tạo khóa API
Chọn khóa thuộc về ai và được gọi những ứng dụng nào, rồi thêm khóa vào dịch vụ của bạn.
- 03
Thực hiện lệnh gọi
Chờ kết quả, hoặc chạy bất đồng bộ, giữ mã lần chạy và nhận callback khi hoàn tất.
Danh sách endpoint
Mọi endpoint đều nằm dưới /open/v1. Xác thực bằng cách gửi khóa API dưới dạng Bearer token trong header của yêu cầu.
Ứng dụng
- GET
/appsLiệt kê các ứng dụng khóa này gọi được - GET
/apps/agent/{app_id}/configLấy cấu hình gọi của tác nhân hoặc Tác nhân điều phối - GET
/apps/workflow/{app_id}/configLấy các biến đầu vào của quy trình làm việc
Tác nhân và Tác nhân điều phối
- POST
/apps/agent/runBắt đầu cuộc trò chuyện, hỗ trợ streaming - POST
/apps/agent/async-runBắt đầu lần chạy bất đồng bộ, có thể kèm URL callback - GET
/apps/agent/async-runs/{run_id}Lấy trạng thái và câu trả lời của lần chạy bất đồng bộ
Quy trình làm việc
- POST
/apps/workflow/runChạy quy trình và stream tiến độ dưới dạng sự kiện - POST
/apps/workflow/sync-runChạy quy trình và chờ đầu ra cuối cùng - POST
/apps/workflow/async-runBắt đầu lần chạy bất đồng bộ, có thể kèm URL callback - GET
/apps/workflow/async-runs/{run_id}Lấy kết quả của lần chạy bất đồng bộ
Tệp
- POST
/files/uploadTải tệp lên để dùng làm đầu vào cho lần chạy
Những cách sử dụng
Phân loại ticket mới
Mỗi ticket mới sẽ gọi tác nhân phân loại, và gợi ý của tác nhân được ghi ngược vào ticket.
Câu lệnh “Đánh giá mức khẩn cấp của ticket này và gợi ý nhóm phụ trách. Chỉ điền vào các trường gợi ý, không trả lời khách hàng.”
Soạn email theo dõi trong CRM
Nhân viên kinh doanh bấm một nút, CRM gọi tác nhân và tác nhân soạn email dựa trên các cuộc trao đổi gần nhất.
Câu lệnh “Soạn email theo dõi cho thương vụ này dựa trên ba cuộc trao đổi gần nhất, theo giọng văn của chính nhân viên phụ trách. Không hứa giảm giá, để bản nháp cho nhân viên kiểm tra.”
Đối soát qua đêm
Một tác vụ định kỳ gọi quy trình làm việc, sáng ra đã có danh sách ngoại lệ.
Câu lệnh “Đối chiếu file xuất đơn hàng hôm nay với bảng tồn kho và liệt kê các mặt hàng còn đủ hàng dưới 7 ngày. Chỉ cần danh sách, không tạo đơn đặt hàng.”
Bạn quyết định mỗi khóa được gọi gì
Khóa API được quản lý tách biệt với quyền truy cập của thành viên trong Evose.
- Chỉ các ứng dụng bạn chọnKhi tạo khóa, chọn khóa thuộc về ai và được gọi những ứng dụng nào. Lệnh gọi ngoài phạm vi đó sẽ bị từ chối.
- Hạn dùng và công tắc tắtĐặt ngày hết hạn, tắt hoặc xóa khóa bất cứ lúc nào. Danh sách hiển thị lần dùng gần nhất của từng khóa.
- Mức sử dụng theo từng khóaXem riêng chi phí và mức dùng hạn mức của từng khóa trong Khả năng quan sát.
Câu hỏi thường gặp
Thực hiện lệnh gọi API đầu tiên
Xây dựng tác nhân trong Evose, tạo khóa và kết nối với hệ thống của bạn bằng vài dòng mã.