Skip to content
Last updated

Tham chiếu Local API

Local API của RPA trình duyệt do ứng dụng MoreLogin trên máy tính phiên bản V2.73.0 trở lên cung cấp tại http://127.0.0.1:<port>/api/rpa/browser/v1. Hãy dùng cổng Local API hiển thị trong phần cài đặt của ứng dụng; cổng mặc định là 40000.

Cơ chế xác thực truy cập giống như ở các phần khác của Local API; xem Xác thực. Gửi phần thân JSON kèm Content-Type: application/json. Phản hồi thành công có dạng {data,meta} và phản hồi lỗi có dạng {error,meta}. Lỗi xác thực truy cập dùng định dạng 401 tiêu chuẩn của Local API. Hãy xử lý lỗi dựa trên trạng thái HTTP, error.code, details và đường dẫn của từng vấn đề, không dựa trên nội dung thông báo. Quy ước API mô tả đầy đủ các quy tắc.

Danh sách endpoint

Khả năng và nút

Thao tácPhương thức và đường dẫn tương đối
Lấy khả năngGET /capabilities
Liệt kê loại nútGET /node-types
Lấy hợp đồng nútGET /node-types/{nodeType}

Xác thực quy trình

Thao tácPhương thức và đường dẫn tương đối
Xác thực quy trìnhPOST /validations

Mẫu và chỉnh sửa nút

Thao tácPhương thức và đường dẫn tương đối
Liệt kê mẫuGET /templates
Tạo mẫuPOST /templates
Lấy mẫuGET /templates/{templateId}
Thay thế mẫuPUT /templates/{templateId}
Xóa mẫuDELETE /templates/{templateId}
Sao chép mẫuPOST /templates/{templateId}/copies
Liệt kê nút của mẫuGET /templates/{templateId}/nodes
Chỉnh sửa nút của mẫuPOST /templates/{templateId}/node-edits

Lượt chạy và kết quả

Thao tácPhương thức và đường dẫn tương đối
Bắt đầu lượt chạyPOST /runs
Liệt kê lượt chạyGET /runs
Lấy chi tiết lượt chạyGET /runs/{runId}
Hủy lượt chạyPOST /runs/{runId}/cancel
Liệt kê lượt thực thi nútGET /runs/{runId}/nodes
Liệt kê tạo phẩm của lượt chạyGET /runs/{runId}/artifacts

Khôi phục yêu cầu

Thao tácPhương thức và đường dẫn tương đối
Lấy biên nhận yêu cầuGET /requests/{key}

Tham chiếu chung

Header bắt buộc cho yêu cầu ghi

Thao tácIdempotency-KeyX-RPA-Catalog-RevisionIf-Match
Tạo mẫuKhuyến nghịBắt buộc—
Thay thế mẫuKhuyến nghịBắt buộcBắt buộc
Xóa mẫuKhuyến nghịKhông cầnBắt buộc
Sao chép mẫuKhuyến nghịBắt buộcBắt buộc: ETag của mẫu nguồn
Chỉnh sửa nút của mẫuKhuyến nghịBắt buộcBắt buộc
Bắt đầu lượt chạyKhuyến nghịBắt buộc—
Hủy lượt chạyKhuyến nghịKhông cần—

Idempotency-Key là tùy chọn, nhưng nếu không có header này, một lần thử lại sau khi hết thời gian chờ có thể lặp lại thao tác ghi. Hãy tạo UUID mới cho mỗi ý định ghi mới, và giữ UUID đó cùng với phương thức, đường dẫn, phần thân và If-Match cho đến khi bạn biết kết quả. If-Match nhận chính xác ETag do Lấy mẫu trả về. X-RPA-Catalog-Revision nhận data.catalogRevision từ Lấy khả năng. Xác thực quy trình là thao tác chỉ đọc, không cần header nào trong số này và không để lại biên nhận yêu cầu.

Hợp đồng cục bộ dạng máy đọc được

Đọc /openapi.json tại URL cơ sở cục bộ để lấy hợp đồng HTTP. URL schema của quy trình nằm trong data.docs.schema của phản hồi GET /capabilities.

Chỉnh sửa mẫu hiện có

Đọc mẫu mới nhất và hợp đồng của các nút bạn sẽ chỉnh sửa. Với thay đổi một phần, hãy áp dụng các chỉnh sửa nút dự kiến lên toàn bộ cây và xác thực với purpose:"save", source.kind:"inline" và source.base:{templateId,version}. Gửi các thao tác bằng node-edits sau khi bản đề xuất vượt qua bước xác thực. Một lô chỉnh sửa hoặc được lưu thành một phiên bản mới, hoặc không thay đổi gì. Hãy gửi nút và khối hoàn chỉnh khi bạn thay thế chúng, và sửa các tham chiếu khi bạn xóa nút. Dùng PUT để thay thế toàn bộ mẫu. Ghi các phụ thuộc mẫu con theo {processId,revisionId} hiện tại của chúng, và đọc lại các phụ thuộc sau khi xảy ra xung đột phiên bản.

Khôi phục

Tình huốngBước tiếp theo
Hết thời gian chờ khi ghi, mất kết nối hoặc kết quả không chắc chắnTruy vấn GET /requests/{originalKey}. Với completed, hãy dùng kết quả ban đầu; với một lượt chạy đã đăng ký xong, bạn vẫn cần kiểm tra trạng thái của lượt chạy đó. Với accepted hoặc committed, hãy thăm dò lại trong một khoảng thời gian có giới hạn. Với unknown, lỗi 404 thông thường hoặc biên nhận đã hết hạn, hãy dừng các thao tác ghi tự động và kiểm tra tài nguyên.
RPA_REQUEST_NOT_COMMITTED kèm safeToRetrySameKey=trueThử lại cùng ý định với khóa, phương thức, đường dẫn và phần thân ban đầu, cùng If-Match ban đầu nếu có.
Xung đột phiên bản 412Kiểm tra biên nhận trước. Sau khi xác nhận rằng thao tác ghi chưa được commit, hãy đọc lại mẫu, hợp nhất, xác thực, rồi gửi với khóa mới và ETag hiện tại.
Danh mục đã thay đổiKiểm tra biên nhận và xác nhận rằng thao tác ghi chưa được commit, sau đó làm mới khả năng và hợp đồng. Nếu phần thân và If-Match giữ nguyên, hãy làm mới header danh mục và giữ khóa ban đầu.
valid=false hoặc lỗi đầu vào có tính xác địnhSửa tại đường dẫn được báo cáo rồi xác thực lại. Nếu thao tác ghi đã được ghi nhận là thất bại, hãy xác nhận rằng không có gì được commit trước khi dùng khóa mới. Khi gặp 429 hoặc 503, hãy làm theo Retry-After và các quy tắc về biên nhận.

Để chạy một mẫu đã lưu, hãy xem Chạy mẫu bằng API.